feat: generate CHANGELOG.md and release notes from commits via git-cliff#3
Merged
Conversation
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CHANGELOG.md(Keep a Changelog style) generated from Conventional Commits with git-cliff; replaces the prior GitHub auto-generated release notescliff.tomlconfig: groups feat/fix/perf/refactor/docs into sections, links PRs, and skips internal ci/chore/style/test commits (the user-facing approach uv and ruff take)scripts/release.sh: one command to bump the version, regenerate the changelog, commit, and tag (mirrors uv/ruffscripts/release.sh)release.yml: new read-onlychangelogjob runs git-cliff and feeds--latestnotes into the GitHub Release body; tag-driven flow otherwise unchangedWhy not rooster (what uv/ruff use): it is Python and PR-label-based, needing a label on every PR. git-cliff fits a solo Rust repo that already uses Conventional Commits.
Validation: generated CHANGELOG.md from real history (0.1.0 + unreleased); actionlint clean on release.yml; shellcheck clean on release.sh