Cut a new stax release with an auto-generated changelog entry.
make release # defaults to a minor bump
make release LEVEL=patch # patch bump
make release LEVEL=major # major bumpDuring cargo release's pre-release hook, git-cliff regenerates the whole CHANGELOG.md from the git history, treating the commits since the latest v<major>.<minor>.<patch> tag as the version being released. Configuration lives in cliff.toml.
git-cliff groups commits by their conventional-commit type:
| Commit prefix | Section |
|---|---|
feat: |
🚀 Features |
fix: |
🐛 Bug Fixes |
refactor: |
🚜 Refactor |
perf: |
⚡ Performance |
docs: |
📚 Documentation |
style: |
🎨 Styling |
test: |
🧪 Testing |
chore: / ci: |
⚙️ Miscellaneous Tasks |
revert: |
◀️ Revert |
| anything else | 💼 Other |
PR references like (#123) become links to the GitHub repo. The automated chore: Release stax version … commits and chore(deps…) bumps are skipped. Non-conventional squash-merge subjects are kept (in 💼 Other) rather than dropped, so no change silently disappears.
make releasedefaults to a minor bump. UseLEVEL=patch,LEVEL=minor, orLEVEL=majorto control the semver bump.- For a dry run, invoke
cargo release <level> --no-confirmdirectly without--execute; cargo-release skips the version bump, tag, and push. git-cliff still rewritesCHANGELOG.mdin place — rungit checkout CHANGELOG.mdto discard it. - Preview the upcoming entry without touching the file:
git-cliff --unreleased --tag v<next-version>. make releaseinstallscargo-releaseviacargo installif it is missing, and installs or reinstallsgit-cliffat the version pinned byGIT_CLIFF_VERSIONin the Makefile when it is missing or a different version. Override the pin for one run withmake release GIT_CLIFF_VERSION=x.y.z.