Add an OpenAPI compatibility gate to CI
A compatibility gate turns an API-design guideline into an enforceable merge rule. The most reliable check runs automatically and produces a result reviewers can understand.
Trigger from pull requests
The GitHub App receives pull-request events and queues a contract comparison when a supported API specification changes.
Compare base with head
The proposed specification is compared with the pull request's base branch, matching the exact compatibility decision required before merge.
Return a native status
The result appears in GitHub Checks with a clear conclusion and a summary of each detected contract change.
Require the result
Add API Contract Guard to a repository ruleset or branch-protection rule to prevent accidental breaking changes from merging.
Protect every pull request automatically
Install the GitHub App, choose a repository and get a clear pass or fail status whenever its OpenAPI contract changes.
Frequently asked questions
Do I need to edit a workflow file?
No. The GitHub App runs from installation and pull-request events, so there is no action YAML to copy into every repository.
What happens when no OpenAPI file changes?
The App only needs to perform compatibility work for relevant contract changes.
Can it be a required check?
Yes. GitHub rulesets and branch protection can require the check before merging.
Does it work across an organisation?
Yes. Pro and Teams plans cover multiple repositories, and Teams supports shared workspace access and multiple installations.