GraphQL Schema Checks with GitHub Actions
In a recent blog post, 4 Ways to Perform GraphQL Schema Checks with Inigo, we explored the benefits of data-driven GraphQL backward compatibility during schema checks and shared insights into when and where to run them.
Today, we’re thrilled to announce Inigo’s GraphQL Schema Checks GitHub Action—available now at GitHub. With this integration, schema changes and errors are surfaced directly in GitHub pull requests, enabling seamless checks for:
- Composition errors
- Linting issues
- Breaking changes
Why It’s a Game-Changer
Integrating schema checks into your GitHub pull request workflow means developers can catch errors earlier in the development process. By showing issues—like breaking changes—right alongside your code, this action dramatically improves developer experience and reduces the risk of introducing schema-breaking updates.
For example, linting errors are displayed directly within GitHub:
How to Get Started
Setting up the Inigo GitHub Action is quick and easy. Just add the following to your GitHub Actions workflow file:
- name: Inigo GraphQL
uses: inigolabs/github-action@main
with:
username: ${{ secrets.INIGO_USERNAME }}
password: ${{ secrets.INIGO_PASSWORD }}
path: configs/*.yml
For detailed step-by-step instructions, visit our guide here.
With Inigo’s GraphQL Schema Checks GitHub Action, you can empower your team to deliver robust, backward-compatible GraphQL APIs while enhancing your CI/CD pipeline efficiency. Try it today and see how seamless schema management can be!
