It would be great if we could automatically generate our CHANGELOG.md instead of maintaining it by hand.
There are a few tools for that, one of them being git-cliff^1. It would make sense to use it, since it is integrated in release-plz^2, but we disabled it at the moment.
We could update the CHANGELOG for every commit being released on master, but I think it makes more sense to just do it on the release. Also this is the behavior from release-plz.
The problem with git-cliff is that it expects conventional commits^3, which we do not have and therefore it generates a broken CHANGELOG. So we need to configure it through the git-cliff.toml in a way that it can handle our commit messages.
It would be great if we could automatically generate our
CHANGELOG.mdinstead of maintaining it by hand.There are a few tools for that, one of them being
git-cliff^1. It would make sense to use it, since it is integrated inrelease-plz^2, but we disabled it at the moment.We could update the CHANGELOG for every commit being released on master, but I think it makes more sense to just do it on the release. Also this is the behavior from release-plz.
The problem with
git-cliffis that it expects conventional commits^3, which we do not have and therefore it generates a broken CHANGELOG. So we need to configure it through thegit-cliff.tomlin a way that it can handle our commit messages.