Changelogs

It is important to maintain a clear changelog so other areas of the business can see what has been done and when. This is especially important for the product team to see what has been released and when.

It will also be used by marketing to keep our roadmap up to date.

Creating a changelog

Changelogs are created from the commit messages. See Git for more information on how to write commit messages.

To create a changelog from commit messages, we use git cliff, this will use the clidd.toml in the root of the repo as a configuration file.

You can install git cliff locally but it is just as easy to use docker. Example:

cd district-core
docker run -t -v "$(pwd)":/app/ "orhunp/git-cliff:${TAG:-latest}"

This will generate a changelog for all commits, but likely you just want what has changed since the last tag. In that case, you add the tag range in the format of START_TAG..END_TAG flag. Example:

docker run -t -v "$(pwd)":/app/ "orhunp/git-cliff:${TAG:-latest}" 0.5.60..0.5.70

Prepending to the changelog

Most of the time, you will want to prepend the changelog to the existing changelog. This can be done with the following:

docker run -t -v "$(pwd)":/app/ "orhunp/git-cliff:${TAG:-latest}" -p CHANGELOG.md 0.5.60..0.5.70