Skip to content

CHANGELOG.md retired: the release notes are the pull request titles #58

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
apostasie merged 1 commit into from
Oct 8, 2026
Merged

CHANGELOG.md retired: the release notes are the pull request titles #58

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
95 changes: 0 additions & 95 deletions CHANGELOG.md
View file
Open in desktop

This file was deleted.

7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,11 @@ tracks releases like any other dependency.

A release is a signed tag on `main`, cut with `just do release vX.Y.Z` by a
repository admin; `go install` and tool directives take it from the module
proxy. Before tagging: `just lint` and `just test` green on CI, and
`CHANGELOG.md` moved from *Unreleased* to the version with the date.
proxy. Before tagging: `just lint` and `just test` green on CI, and every
merged pull request's title saying what changed for a user: the release
notes are those titles, published on the tag's release page with
`gh release create vX.Y.Z --verify-tag --generate-notes`, and one that
breaks a consumer carries the `breaking` label.

## Licence

Expand Down
Loading