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

  1. Install clog: cargo install clog-cli
  2. Run clog --setversion <X>.<Y>.<Z>
  3. Massage the output as needed.