DOCUMENT OPS

Release-tag doc coverage report to Confluence

When you publish a GitHub release, it builds a documentation coverage report for that version — which new endpoints shipped documented vs. undocumented — and publishes it…

CategoryDocument Ops
Enginesim
Difficultyintermediate
Triggerevent
Steps5
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerGitHub release publishedGitHubGitHub
  • ActionCompute endpoint delta since previous tagGitHubGitHub
  • ActionFetch documented surface from ReadMeReadMeReadMe
  • LogicClassify coverage and score the release
  • OutputPublish coverage report to ConfluenceConfluenceConfluence

What it does

Produces an auditable per-release documentation coverage record. On each tagged release it diffs the API surface introduced since the previous tag against what ReadMe documents, then writes a stakeholder-friendly Confluence page summarizing what shipped with docs and what didn't.

When to use it

Use it when release governance or compliance requires evidence that shipped features were documented, or when product and support need a per-version reference of doc completeness. Tie it to your release process so the report is always current with the latest tag.

How it works

  1. 1A GitHub release published event triggers the workflow.
  2. 2It computes the endpoints added or changed between the previous tag and this release.
  3. 3It fetches the documented surface from ReadMe and matches it against the release delta.
  4. 4A logic step classifies each new endpoint as documented, partially documented, or missing, and calculates an overall coverage score.
  5. 5It publishes a formatted coverage report as a Confluence page under the release space, linked from the release notes.

Set it up

What you configure once, before turning it on.

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