CHANGELOG
Providing a meaningful changelog is helpful for your users, particularly for recording breaking changes and how people can migrate between versions.
Writing a Changelog with clog
clog
can help you write your changelog.
Pre-requisites:
- Commits in conventional style.
- gitcop is a bot to enforce a specific commit style.
- Releases are tagged.
- The previous release is the most recent tag.
Steps
- Install clog:
cargo install clog-cli
- Run
clog --setversion <X>.<Y>.<Z>
- Massage the output as needed.