ENGINEERING

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.

CategoryEngineering
Enginesim
Difficultyintermediate
Triggerevent
Steps5
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerSemver release tag pushedGitHubGitHub
  • ActionPull spec at new + previous tagGitHubGitHub
  • LogicClassify changes into changelog sections
  • ActionRender Confluence changelog body
  • OutputPublish versioned page to ConfluenceConfluenceConfluence

What it does

Turns each tagged API release into a permanent, readable changelog entry in Confluence. It collects every spec change since the prior tag, groups them into Breaking, Added, and Fixed, and publishes a new child page under your API docs space with the version, date, and migration guidance.

When to use it

Your platform team cuts versioned API releases and downstream teams keep asking "what changed in v2.4?" Use this to make the answer self-serve and authoritative instead of buried in commit history.

How it works

  1. 1A release tag matching `v*.*.*` is pushed, triggering the flow.
  2. 2Pull the commit range and the OpenAPI spec at both the new tag and the previous tag from GitHub.
  3. 3Diff the specs and classify each change into Breaking / Added / Fixed buckets.
  4. 4Render a Confluence-formatted changelog body with the version header and migration notes.
  5. 5Create the page as a child of the API docs parent page in Confluence.
  6. 6Link the published page back on the GitHub release notes.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect GitHubRepos, issues, pull requests, actions.
  2. 2
    Connect ConfluenceSpaces, pages, blueprints.
  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.