A GitHub App built with Probot that prevent Breaking Changes in a GraphQL API using GitHub Checks API.
When using Continuous Evolution you have to prevent any Breaking Changes to your GraphQL API. That's why we recommend to commit a dump of your GraphQL schema (using SDL) inside your repository (eg: with a
graphql-doctor will use your current schema and compare it with the previous schema (eg: the schema on the
master branch) then it guess if you made some Breaking or Dangerous changes !
You can look at this Pull request.
Show issues right in your schema
Generate a failure in case of Breaking Changes
Add the following key to your
This will compare your current
schema.public.graphql in the
We don't provide a public application (yet!) but you can easily deploy your own. Internally we are using heroku :
git push heroku master
# Install dependencies
# Run the bot
# Run tests
If you have suggestions for how graphql-doctor could be improved, or want to report a bug, open an issue! Any kind of contributions is greatly appreciated.
For more, check out the Contributing Guide.