-
Notifications
You must be signed in to change notification settings - Fork 25
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
Adds Automatic CHANGELOG.md Generation #145
Conversation
This commits adds a Docker image that includes a tool that automatically generates changelogs. See: https://github.com/skywinder/github-changelog-generator This tool relies on Github metadata to generate the Changelog. This has the advantage that it knows more than the Git history e.g. PRs, Labels... The here proposed workflow is to not include the generation of the changelog into CI, but rather manually run it for each major version. It's easy enough: rm CHANGELOG.md make CHANGELOG.md
Needs smarter Github token handling... The token has ben automatically detected and revoked... |
Nice! But this would also require us to do manual version bumping and in general decide how to manage versions going forward, correct? |
Yes, I was thinking about aligning a minor version bump with the monthly sprints. The changelog can pick up all tags that fit a specific regex and group by that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very cool. I want something like this for Elektra as well. It requires some discipline for people to properly handle issues, pull requests etc. but that's a good thing. Also like the idea to make a new minor version per review cycle. so the changelog gets a nice grouping.
This commits adds a Docker image that includes a tool that automatically
generates changelogs.
See: https://github.com/skywinder/github-changelog-generator
This tool relies on Github metadata to generate the Changelog. This has
the advantage that it knows more than the Git history e.g. PRs,
Labels...
The here proposed workflow is to not include the generation of the
changelog into CI, but rather manually run it for each major version.
It's easy enough: