ENGINEERING
Generate a plain-English migration brief for breaking API changes
After a breaking OpenAPI change is detected, uses an LLM to write a human-readable migration guide explaining what changed and how callers should adapt.
How it runs
The automated pipeline, trigger to output.
- TriggerBreaking diff produced for a release tagGitHub
- ActionPull structured field-level diffGitHub
- ActionGenerate plain-English migration briefOpenAI
- LogicFormat brief into release-note markdown
- OutputCreate draft GitHub release with the briefGitHub
What it does
Translates a raw spec diff into a migration guide a consumer can actually follow. When a breaking change is detected, it feeds the structured diff to an LLM that explains each change in plain English, shows before/after request shapes, and lists the concrete code edits a caller must make, then drafts it as a GitHub release note.
When to use it
Use it when your API has external or cross-team consumers who need clear upgrade instructions, and you want consistent, well-written migration docs without an engineer hand-writing them every release.
How it works
- 1The workflow is triggered when a breaking-change diff is produced for a tagged release.
- 2It pulls the structured list of removed, renamed, and retyped fields from the spec diff.
- 3An OpenAI step turns the diff into a migration brief with rationale, before/after examples, and an action checklist.
- 4A formatting step assembles the brief into release-note markdown.
- 5It creates a draft GitHub release containing the migration brief for review before publishing.
Set it up
What you configure once, before turning it on.
- 1Connect GitHubRepos, issues, pull requests, actions.
- 2Connect OpenAIModels, embeddings, files.
- 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
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.