Skip to content

docs(agents): align AGENTS.md §11 changelog/release contract with ADR-0038 #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielPoloWork merged 1 commit into from
Jun 15, 2026
Merged

docs(agents): align AGENTS.md §11 changelog/release contract with ADR-0038 #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ The project follows **Semantic Versioning 2.0.0**. Tags are annotated and have t

**Post-1.0 (`MAJOR.MINOR.PATCH`)** — standard SemVer; `MAJOR` for source-/ABI-incompatible changes, `MINOR` for additions, `PATCH` for fixes.

**`CHANGELOG.md`** — Keep a Changelog 1.1.0 format. Every PR that introduces user-visible change adds a line to the `Unreleased` section in the same PR; release PRs roll `Unreleased` into the new version block.
**`CHANGELOG.md`** — Keep a Changelog 1.1.0 format. Released entries are **immutable, one file per release** under `docs/changelog/v<MAJOR>/v<X.Y.Z>.md`; the root `CHANGELOG.md` keeps only the `[Unreleased]` block and the *Released versions* index ([ADR-0038](docs/adr/0038-changelog-version-split.md)). Every PR that introduces user-visible change adds a line to the root `Unreleased` section in the same PR; a release PR **moves** `Unreleased` into a new per-version file and adds an index row ([`docs/workflow/release.md`](docs/workflow/release.md) §3) — it does not edit a released file.

**Release artifacts** — on each `v*` tag push, the `release` CI workflow re-runs the full test matrix, builds per-platform binaries (Linux x86_64, Windows x86_64, macOS arm64), produces `SHA256SUMS`, and creates a **draft** GitHub Release. The maintainer reviews and clicks *Publish*.

Expand All @@ -315,7 +315,7 @@ The project follows **Semantic Versioning 2.0.0**. Tags are annotated and have t
| Action | Who |
|-------------------------------------------------------|----------|
| Bump version constant in source | Agent |
| Update `CHANGELOG.md` (Unreleased → version) | Agent |
| Move `Unreleased` → `docs/changelog/v<MAJOR>/v<X.Y.Z>.md` + index row | Agent |
| Draft GitHub Release notes (`docs/releases/v<X.Y.Z>.md`) | Agent |
| Open the release PR | **Human**|
| Merge the release PR | **Human**|
Expand Down
8 changes: 4 additions & 4 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ dated version block (`## [X.Y.Z] — YYYY-MM-DD`) when a release PR closes a mil
`docs/changelog/v<MAJOR>/v<X.Y.Z>.md`; the root `CHANGELOG.md` now keeps only the
preamble, `[Unreleased]`, and the *Released versions* index below — dropping from
1129 to ~100 lines. Keep a Changelog and the root-file location are preserved;
the `version-lockstep` consistency check and [`release.md`](docs/workflow/release.md)
roll-over mechanic were updated accordingly. Rationale (incl. why not a calendar
or XML/Liquibase split) in [ADR-0038](docs/adr/0038-changelog-version-split.md).
Documentation/tooling-only.
the `version-lockstep` consistency check, [`release.md`](docs/workflow/release.md)
§3, and the `AGENTS.md` §11 release contract were updated to match. Rationale
(incl. why not a calendar or XML/Liquibase split) in
[ADR-0038](docs/adr/0038-changelog-version-split.md). Documentation/tooling-only.

## Released versions

Expand Down
Loading