ENGINEERING
Notify downstream consumers when a tagged API release changes the contract
When you push a release tag, diff the published OpenAPI spec against the previous release and broadcast a plain-English changelog of breaking and additive changes to every…
How it runs
The automated pipeline, trigger to output.
- TriggerRelease tag pushed (v*)GitHub
- ActionFetch spec at new tag and previous releaseGitHub
- ActionDiff endpoints and schemas between releases
- ActionSummarize diff into a migration changelogOpenAI
- LogicRoute by severity (breaking vs additive)
- OutputPost changelog to consumer Slack channelsSlack
What it does
On each new release tag, this workflow pulls the OpenAPI spec at the new tag and at the prior release, diffs them, summarizes the differences into a human-readable changelog, and posts a clearly formatted message to the channels of teams that consume the API.
When to use it
Use it when you ship versioned API releases and downstream teams keep getting surprised by changes. It turns a silent spec bump into a proactive, routed announcement so integrators see exactly what moved before their next deploy.
How it works
- 1A push of a tag matching your release pattern (e.g. `v*`) triggers the flow.
- 2It retrieves the spec at the new tag and at the previous release tag from GitHub.
- 3A diff step extracts added, removed, and modified endpoints and schemas.
- 4An OpenAI step rewrites the raw diff into a concise migration-focused changelog.
- 5A logic step routes by severity, escalating the message style when breaking changes are present.
- 6The changelog is delivered to the relevant Slack channels for downstream consumers.
Set it up
What you configure once, before turning it on.
- 1Connect GitHubRepos, issues, pull requests, actions.
- 2Connect OpenAIModels, embeddings, files.
- 3Connect SlackChannels, DMs, threads, mentions.
- 4Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
- 5Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
- 6Test, 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.