Release notes
Reloqui generates release notes deterministically from the reconciled evidence — so every statement in a note is backed by a stored record, not hand-written prose.
Five audiences
Section titled “Five audiences”Each release produces notes for five audiences, each framed for its reader:
| Audience | Emphasis |
|---|---|
| Executive | Summary, shipped work items, rollout environments, confidence. |
| Engineering | Merged PRs with commit SHAs, issue keys, backport/heuristic flags, artifacts, exceptions. |
| Operations | Deployment timeline with actors, rollback reference, backports. |
| Product | Customer-facing changes framed by work item — no SHAs. |
| Compliance | Policy result, human-reviewed overrides, exceptions register, evidence count. |
Notable changes (breaking / security / deprecation / feature / fix) lead every audience.
Generate & read
Section titled “Generate & read”Reconcile the release, then Regenerate notes (or POST /api/v1/releases/{id}/notes/regenerate). Read any audience:
GET /api/v1/releases/{id}/notes?audience=engineeringGET /api/v1/releases/{id}/notes?audience=executive&format=markdownformat=markdown returns the raw markdown; the default returns JSON with noteVersion, generatedAt, editedBy and the body.
Regenerate a subset
Section titled “Regenerate a subset”To rebuild only certain audiences:
POST /api/v1/releases/{id}/notes/regenerate{ "audiences": ["executive", "product"] }Regeneration bumps noteVersion, refreshes generatedAt, emits a note.generated event, and records a revision — the source evidence is preserved.
Notes support an editorial pass (PUT /api/v1/releases/{id}/notes) that records editedBy; regeneration and edits both live in the release’s revision trail.
Export
Section titled “Export”Notes are included per-audience in the release export package (GET /api/v1/export/releases/{id}) alongside evidence, approvals and the snapshot reference. Markdown is the native format; use your browser’s print for PDF.