ENGINEERING

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.

CategoryEngineering
Enginesim
Difficultyadvanced
Triggerevent
Steps5
Setup~25 min

How it runs

The automated pipeline, trigger to output.

  • TriggerPR opened or updatedGitHubGitHub
  • ActionDiff spec against base branchGitHubGitHub
  • LogicExit and unblock if not breaking
  • ActionComment impact summary + apply blocking labelGitHubGitHub
  • OutputRequest ack from consumers in SlackSlack

What it does

Makes breaking changes a negotiated event, not a surprise. On any PR that breaks the API contract, it leaves a structured comment listing what breaks and who is affected, adds a `needs-consumer-ack` label that your branch protection treats as blocking, and pings the maintainers of each affected consumer in Slack to review.

When to use it

You want breaking changes to ship only after the teams that depend on them have seen and accepted the impact — useful for platform APIs with strict compatibility commitments.

How it works

  1. 1A PR is opened or updated, triggering the flow.
  2. 2Fetch the changed spec and diff it against the base branch via GitHub.
  3. 3Branch: if no breaking changes, remove any blocking label and exit.
  4. 4Post or update a PR comment summarizing each break and the affected consumers.
  5. 5Apply the `needs-consumer-ack` blocking label via the GitHub API.
  6. 6Notify each affected consumer's maintainers in Slack with the PR link to request acknowledgement.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect GitHubRepos, issues, pull requests, actions.
  2. 2
    Connect SlackChannels, DMs, threads, mentions.
  3. 3
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  4. 4
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  5. 5
    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.