chore: add git-cliff
configs for generating changelogs and release notes
#1047
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.
Type of Change
Description
This PR adds configuration files for
git-cliff
for generating changelogs and release notes. In addition, this PR increases the heading levels for each heading inCHANGELOG.md
file to align with the changelogs generated bygit-cliff
.To update the
CHANGELOG.md
file with the unreleased commits, you can run:To generate release notes for a GitHub release with contributor mentions (you'll also need another tool (disclaimer: I built this) to substitute committer emails with their GitHub usernames):
git-cliff --config .github/git-cliff-release.toml --unreleased | changelog-gh-usernames
This would print the release notes to console, you can pipe it to a tool that copies it to your system clipboard as required.
For the release notes however, there are some cases where we can't consistently obtain GitHub usernames, in which case it would have to be done manually.
Refer to usage information of both of these tools for more complex use cases.
Motivation and Context
Better structured changelogs and release notes.
How did you test it?
Manually.
Checklist
cargo +nightly fmt --all
cargo clippy