Open Projects
v2026.04 GitHub →
/projects/release-notes-agent
updated 2026-04-22

Release Notes Agent

Drafts customer-ready release notes from JIRA and saves them into Heretto as DITA Topics.

Overview

An LLM-driven agent that watches a release branch, reads commit messages, linked tickets, and diffs against the published Heretto topic graph, then drafts release notes in DITA. Reviewers get a PR-style diff against the previous release.

Release Notes Agent is built and maintained by the Heretto team alongside community contributors. It targets workflows where DITA topics, maps, and conrefs need to behave like first-class engineering artifacts — versioned, tested, and reviewable.

Install

Clone the project at:

npm install -g @heretto/release-notes-agent

Usage

Run against any Heretto-compatible content store. The CLI prints a structured report; pass --json for machine-readable output.

release-notes-agent run \
  --content ./content \
  --rules ./.release-notes-agent.toml \
  --format json

What it’s good for

  • Catching broken references before they hit a published runtime.
  • Producing a stable, reviewable artifact for human or agent review.
  • Slotting into existing CI without a new content management system.

License

Apache 2.0. See LICENSE in the repository.