Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate CHANGELOG #91

Open
Urhengulas opened this issue Mar 7, 2024 · 0 comments
Open

Automatically generate CHANGELOG #91

Urhengulas opened this issue Mar 7, 2024 · 0 comments

Comments

@Urhengulas
Copy link
Member

Urhengulas commented Mar 7, 2024

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-cliff1. It would make sense to use it, since it is integrated in release-plz2, 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 commits3, 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.

Footnotes

  1. https://github.com/orhun/git-cliff

  2. https://github.com/MarcoIeni/release-plz

  3. https://www.conventionalcommits.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant