ENGINEERING
Block PRs that introduce breaking OpenAPI changes
On every pull request that touches the OpenAPI spec, diff it against the base branch, classify changes as breaking or additive.
How it runs
The automated pipeline, trigger to output.
- TriggerPull request edits the OpenAPI spec fileGitHub
- ActionFetch base and head versions of the specGitHub
- ActionCompute structural diff between the two specs
- LogicClassify changes: breaking vs additive vs cosmetic
- OutputPost commit status + inline PR comment with verdictGitHub
What it does
Watches pull requests for edits to your `openapi.yaml` (or JSON) spec. When one changes, it compares the PR version against the base branch, separates breaking changes (removed endpoints, deleted fields, narrowed types, new required params) from safe additive ones, and writes the result back to the PR as a status check plus a comment.
When to use it
Use it when multiple teams depend on a shared HTTP API and you want a hard gate in CI rather than relying on reviewers to spot contract regressions by eye. Ideal for platform or API teams enforcing semver discipline on their public surface.
How it works
- 1A pull_request event fires when the spec file is modified.
- 2The flow fetches both the base and head versions of the spec from GitHub.
- 3A diff step computes the structural delta between the two documents.
- 4A logic branch classifies each change as breaking, additive, or cosmetic.
- 5If any breaking change exists, it posts a failing commit status and an inline PR comment listing each violation; otherwise it posts a passing status.
Set it up
What you configure once, before turning it on.
- 1Connect GitHubRepos, issues, pull requests, actions.
- 2Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
- 3Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
- 4Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.
More Engineering workflows
Upgrade Impact Router to Module Code Owners
Maps a dependency-bump PR's affected modules to their CODEOWNERS, then DMs each owner on Slack with only the changelog slice that touches code they own.
Re-Voice IVR Prompts on Phone-Tree Config Merge
When a phone-tree config change merges in GitHub, regenerates the ElevenLabs audio for any prompt whose script changed in the diff and opens a follow-up PR adding the new audio…
Agent reviews model-license fit and suggests compliant swaps on the PR
When a PR adds a Hugging Face model, an agent reads the model card and license, judges fit against your commercial-use policy.
Scan for deprecated endpoints and email consumers a weekly sunset countdown
On a weekly schedule, scans the OpenAPI spec for endpoints marked deprecated with a sunset date, and emails each consuming team a countdown of how many days remain before removal.
Publish a versioned API changelog to Confluence on each release tag
On a new semver release tag, gathers the contract changes since the last release and writes a clean.
Gate breaking API PRs behind downstream consumer acknowledgement
When a PR introduces a breaking contract change, comments the impact summary back on the PR, applies a blocking label.
Run it inside a business
This workflow drops into a full company template. Import the org, and this is one of the playbooks its agents run.
Run this workflow in your colony.
14-day trial. No DevOps. No Sales call. Provisioned in under a minute.