-
Notifications
You must be signed in to change notification settings - Fork 174
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
Use chloggen
go tool for managing the changelog
#637
Use chloggen
go tool for managing the changelog
#637
Conversation
Here is a preview of a CHANGELOG file generated by the new tool (with dummy changelog entries) vTODO🛑 Breaking changes 🛑
💡 Enhancements 💡
🧰 Bug fixes 🧰
|
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.
Generally LGTM, just a question on some of the CONTRIBUTING refactoring.
chloggen
go tool for managing changelogchloggen
go tool for managing the changelog
Moved this out of draft, as folks may not look at things in that state. I still need to work on the automated checks. Update: GH Workflow to check the for the changelog entries is there now. |
chloggen
go tool for managing the changelogchloggen
go tool for managing the changelog
chloggen
go tool for managing the changelogchloggen
go tool for managing the changelog
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.
thanks for working on it!
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.
Thank you!
Fixes #617
Changes
Today it's very cumbersome how the changes in CHANGELOG.md are managed. It's frustrating for all parties:
This PR attempts to add and use the chloggen tool, the same way that the collector repos use.
I also did a revamp in the contributing guide and tried to make it as friendly as possible for new contributors.
Note: It is still missing the new steps for making a release, but once this is merged I will also update that.