← Back to Docs
Recipe

Recipe: Release notes QA bot

Automate release-note validation with a self-hosted QA agent that diffs changelogs against your shipped artifacts.

Ingredients

  • Meridian agent installed on your CI runner
  • Access to your release pipeline logs
  • A markdown changelog checked into the repo
  • One webhook endpoint (Slack or Discord)

Steps

  1. Wire the agent trigger

    Configure Meridian to fire on your “release published” event. Pass the tag and artifact SHA as parameters.

  2. Diff the changelog

    The agent compares the changelog entries against the actual files shipped in the release bundle. Missing entries or stale references are flagged.

  3. Run the QA checklist

    Built-in checks verify semver compliance, deprecation notices, and breaking-change callouts. Custom rules can be added via the Meridian policy file.

  4. Post the verdict

    Results are pushed to your webhook. Pass? Green embed. Issues found? The bot lists every violation with a link to the offending line.

Pro tip

Pair this recipe with the “Changelog drift monitor” to catch regressions between nightly builds before they reach a tagged release.