Migrate from 2025-Q1 to 2025-Q2

What Changed

query { node(id: "someId") { ... on Issue { title } } }

query { nodeAlias: node(id: "someId") { ... on Issue { title } } }

Migration Steps

1. 1

   Identify `node` field usage

   code

   Review your codebase to locate all GraphQL queries that directly use the `node` field. Pay close attention to any client-side GraphQL libraries or SDKs you might be using.

   • ↳Use code search tools for `query { node(` or similar patterns.
   • ↳Check generated client code if applicable.
2. 2

   Update GraphQL queries

   code

   Modify identified queries to use an alias for the `node` field. This involves adding a custom name before the `node` field, like `myNode: node(...)`.

   • ↳Ensure the alias is unique within the query.
   • ↳Update any variables or fragments referencing the old field name.
3. 3

   Update SDK/Client code

   code

   If you are using a GraphQL client library or SDK that generates types or directly invokes queries, update it to the latest version that supports the 2025-Q2 schema. Regenerate client code if necessary.

   • ↳Check your library's release notes for compatibility information.
   • ↳Re-run code generation scripts.
4. 4

   Run automated tests

   test

   Execute your existing test suite. Ensure all unit, integration, and end-to-end tests that involve GitHub GraphQL API interactions pass successfully.

   • ↳Focus on tests that query or manipulate resources using the `node` field.
   • ↳Verify that data fetching and processing logic still works as expected.
5. 5

   Perform manual testing

   test

   Conduct manual testing of critical user flows and features that rely on the updated GraphQL queries. This helps catch any subtle issues that automated tests might miss.

   • ↳Test edge cases and common user scenarios.
   • ↳Use browser developer tools to inspect network requests and responses.
6. 6

   Deploy to staging

   deploy

   Deploy the updated application to a staging environment that mirrors production. This provides a final opportunity to test in a production-like setting before full release.

   • ↳Monitor logs for any new errors or warnings.
   • ↳Perform a smoke test on the staging deployment.
7. 7

   Deploy to production

   deploy

   Once confident, roll out the changes to your production environment. Consider a phased rollout or canary deployment if applicable.

   • ↳Monitor key performance indicators (KPIs) closely post-deployment.
   • ↳Have a rollback plan in place.
8. 8

   Monitor post-deployment

   verify

   Continuously monitor application performance, error rates, and user feedback after the production deployment. Address any issues promptly.

   • ↳Keep an eye on GitHub API rate limits.
   • ↳Alert relevant teams about any anomalies.

Testing Checklist

1. 1.

   Verify `node` field queries with aliases

   Inspect GraphQL network requests and responses in dev tools.

2. 2.

   Confirm data integrity for affected resources

   Compare data fetched before and after migration.

3. 3.

   Check for GraphQL errors in logs

   Monitor application and API gateway logs.

4. 4.

   Validate user-facing functionality

   Perform manual user acceptance testing (UAT).

Common Mistakes