Put API compatibility inside every pull request
API compatibility works best when it is part of the merge path. Contract Guard installs at repository level and reports directly where developers already review changes.
Install for selected repositories
A GitHub organisation owner can grant access to all repositories or only the repositories that contain API contracts.
Detect changed specifications
Pull-request events trigger a comparison when supported OpenAPI JSON or YAML files change between the base and head branches.
Publish a GitHub check
The result includes the number of breaking changes and concrete details for affected paths, responses, parameters and schemas.
Use branch protection
Make the check required in GitHub rulesets so a breaking contract cannot merge until it is fixed or intentionally redesigned.
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
Does every repository need configuration?
The App automatically looks for supported OpenAPI files. Repository access is controlled through the normal GitHub App installation settings.
Can I install it on private repositories?
Yes, when the GitHub App is granted access to those repositories.
Does it comment on pull requests?
It publishes a GitHub check run, giving reviewers a native pass or fail status and compatibility summary.
How many repositories are included?
Starter includes 3, Pro includes 20, and Teams includes 50 repositories.