Repository navigation
ci(release): automate changelog generation - #122
Merged
Merged
Conversation
Generate a deterministic changelog section from Conventional Commits via tools/changelog.py, keeping human edits outside generated markers. Fail clearly when a range has no releasable changes. Add docs/RELEASE.md and a dry-run workflow. Closes #113
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
2 participants
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.
Closes #113
What
Adds deterministic changelog generation from Conventional Commits.
tools/changelog.py: groups commits by type (feat/fix/perf/...), detects breaking changes, fails clearly when a range has no releasable changes, and splices output intoCHANGELOG.mdbetween generated markers so hand-written text is preserved..github/workflows/changelog.yml: dry-run onworkflow_dispatchand on release; uploads the generated section as an artifact and never commits on its own.docs/RELEASE.md: release guide documenting the process.tools/tests/test_changelog.py: unit tests and a dry-run on a sample range.Verification
python -m unittest discover -s tools/tests-> 9 passedpython tools/changelog.py --version 0.2.0 --to HEAD-> deterministic sectionpython tools/changelog.py --from HEAD --to HEAD-> exits 1 with a clear error--writesplices between markers and preserves surrounding textcargo fmt --all -- --check,cargo clippy --all-targets --all-features -- -D warnings,cargo test --allall pass