docs: document the machine-written changelog policy #39

Merged
rcsheets merged 1 commit from docs/changelog-policy-note into main 2026-06-27 02:28:48 +00:00
Owner

CHANGELOG.md is generated from each release's commit range by
hack/update-changelog.sh and committed automatically by the publish
workflow; it is not hand-edited and has no Unreleased section. Record
that policy where contributors will look: a CI-conventions bullet in
CLAUDE.md and a Changelog section in the README, both noting that the
lever for changelog content is a good commit message.

The changelog automation itself already landed on main via earlier PRs;
this only adds the missing documentation for it.

CHANGELOG.md is generated from each release's commit range by hack/update-changelog.sh and committed automatically by the publish workflow; it is not hand-edited and has no Unreleased section. Record that policy where contributors will look: a CI-conventions bullet in CLAUDE.md and a Changelog section in the README, both noting that the lever for changelog content is a good commit message. The changelog automation itself already landed on main via earlier PRs; this only adds the missing documentation for it.
docs: document the machine-written changelog policy
Some checks failed
CI (next Go) / next-go (tip) (pull_request) Successful in 4m31s
CI / ci (pull_request) Failing after 2s
0abc51449b
CHANGELOG.md is generated from each release's commit range by
hack/update-changelog.sh and committed automatically by the publish
workflow; it is not hand-edited and has no Unreleased section. Record
that policy where contributors will look: a CI-conventions bullet in
CLAUDE.md and a Changelog section in the README, both noting that the
lever for changelog content is a good commit message.

The changelog automation itself already landed on main via earlier PRs;
this only adds the missing documentation for it.
Collaborator

Automated review by pr-reviewer v0.29.1 | Safety Check | Mistral Small | tracking id r-3f355a-b6b940
This is an AI-gene2ated review and may contain mistakes.

Status: Failed


Review failed. Tracking id r-3f355a-b6b940 — see logs for details.

Comment @pr-reviewer-bot retry to try again.

*Automated review by [pr-reviewer](https://git.brooktrails.org/brooktrails/pr-reviewer) v0.29.1 | Safety Check | Mistral Small | tracking id `r-3f355a-b6b940`* *This is an AI-gene2ated review and may contain mistakes.* **Status:** ❌ Failed --- Review failed. Tracking id `r-3f355a-b6b940` — see logs for details. Comment `@pr-reviewer-bot retry` to try again.
rcsheets deleted branch docs/changelog-policy-note 2026-06-27 02:28:48 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
brooktrails/forgejo-runner-operator!39
No description provided.