ci: group and filter release notes so they summarize changes#317
Merged
Conversation
The generated changelog listed every commit as `sha: subject`, which reads as raw version-control output rather than release notes. Group the Conventional Commit subjects into Features, Bug fixes, Performance, and Security sections, send the rest to Other changes, and filter out docs, tests, formatting, chores, CI, build, and merge commits, so each release summarizes the user-facing changes.
ion-alpha-dev
force-pushed
the
ci/release-notes-grouped
branch
from
4bf29f0 to
aee1708
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Configure the GoReleaser changelog with groups and filters so generated release notes are grouped into Features, Bug fixes, Performance, and Security sections, with docs, tests, formatting, chores, CI, build, and merge commits filtered out.
Why
The previous changelog listed each commit as
sha: subject, which reads as raw version-control output rather than a human-readable summary of changes. Grouping the Conventional Commit subjects and dropping non-user-facing noise makes each release's notes summarize what actually changed, so users can judge whether to upgrade.How to verify
goreleaser checkpasses. On the next tagged release the GitHub Release body shows sectioned notes (Features / Bug fixes / ...) instead of a flat commit list; docs/test/chore/ci commits do not appear.Notes for reviewers
Takes effect on the next release; existing release bodies are unchanged.