ENGINEERING

Block PRs that introduce OpenAPI breaking changes

On every pull request, diffs the committed OpenAPI spec against the base branch, classifies breaking changes.

CategoryEngineering
Enginesim
Difficultyintermediate
Triggerevent
Steps5
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerPR opened or updated touching openapi.yamlGitHubGitHub
  • ActionFetch PR spec and base-branch specGitHubGitHub
  • LogicDiff specs and classify breaking vs additive
  • LogicAny breaking changes found?
  • OutputPost pass/fail status check and inline commentGitHubGitHub

What it does

Guards your API contract at the source. Whenever a pull request touches the OpenAPI spec, this workflow compares the new spec to the version on the base branch, flags backward-incompatible changes (removed endpoints, deleted fields, tightened types, new required parameters), and writes the verdict back to GitHub as a commit status and a review comment.

When to use it

Use it when you publish or consume an OpenAPI spec checked into a repo and want a hard gate so no one accidentally ships a breaking change. Ideal for teams enforcing semver on their API.

How it works

  1. 1A pull request event fires when the spec file changes.
  2. 2The workflow fetches both the PR version and the base-branch version of the spec from GitHub.
  3. 3A diff step computes the structural delta between the two specs.
  4. 4A classifier decides whether any change is breaking versus additive.
  5. 5If breaking, it posts a failing status check and an inline PR comment listing each violation; if clean, it posts a passing check.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect GitHubRepos, issues, pull requests, actions.
  2. 2
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  3. 3
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  4. 4
    Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.

Run this workflow in your colony.

14-day trial. No DevOps. No Sales call. Provisioned in under a minute.