ENGINEERING
Diff OpenAPI on merge and alert consumer Slack channels on breaking changes
When a PR merges to main, diffs the new OpenAPI spec against the previous version, classifies each change as breaking or additive.
How it runs
The automated pipeline, trigger to output.
- TriggerPR merged to default branchGitHub
- ActionFetch new + previous OpenAPI specGitHub
- LogicDiff spec and classify changes
- LogicStop if no breaking changes
- ActionFormat breaking-change summary
- OutputPost alert to consumer Slack channelsSlack
What it does
Watches your API repo for merges to the default branch, compares the committed OpenAPI spec to its prior revision, and surfaces only the changes that will actually break callers — removed endpoints, tightened types, newly required fields, deleted enum values. Additive changes are logged but stay quiet so consumers learn to trust the alert.
When to use it
You publish a REST API consumed by several internal teams and want them warned the moment a breaking edit lands on main, before it reaches their integration tests. Best when your spec lives in-repo and is the source of truth.
How it works
- 1A push/merge to the default branch triggers the flow.
- 2Fetch the new `openapi.yaml` and the version from the previous commit via the GitHub API.
- 3Run a structured diff that buckets each change as breaking, additive, or cosmetic.
- 4Branch: if no breaking changes, stop silently.
- 5For each breaking change, format a human-readable summary (endpoint, what changed, migration note).
- 6Post the summary to the mapped Slack channel for each affected consumer team.
Set it up
What you configure once, before turning it on.
- 1Connect GitHubRepos, issues, pull requests, actions.
- 2Connect SlackChannels, DMs, threads, mentions.
- 3Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
- 4Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
- 5Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.
More Engineering workflows
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.
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.
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.
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…
Upstream Release to Notion Upgrade Brief
When a watched package publishes a new release, fetches the release notes, maps them to the internal modules that depend on it.
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.