Where GitHub GraphQL API Schema should be managed

[cia-rana]

Select Topic Area

General

Body

It is recommended that GitHub GraphQL API Schema be managed using Git within the GitHub officially repository.

Currently, they are managed within GitHub's documentation and downloaded for use. However, this complicates the tracking of when and where updates occur.
Recently, GitHub released new features, which also involved updates to the GraphQL API. Without comparing the diff against a previously downloaded schema, it was difficult to identify exactly what had changed.

[jfullstackdev]

not very sure of your situation but these might help :

1. self-manage in your repo

   • Store a baseline schema (schema.graphql) in your repo.
   • Use a GitHub Action or cron job to periodically fetch the latest schema and run graphql-inspector diff.
   • Commit updates so your team can track schema evolution in Git history.

2. use graphql-inspector or Apollo tooling

   • These tools can fetch and compare schemas automatically.
   • They can even fail CI builds if breaking changes appear.

3. community-maintained mirror

   • Some teams maintain their own “GitHub GraphQL schema mirror repo” internally.
   • This serves as the “source of truth” for tracking diffs.

[cia-rana]

It is possible to version control the schema in our repo, but why doesn't GitHub officially do that?