Use chloggen go tool for managing the changelog#637
Merged
joaopgrassi merged 22 commits intoopen-telemetry:mainfrom Feb 5, 2024
Merged
Use chloggen go tool for managing the changelog#637joaopgrassi merged 22 commits intoopen-telemetry:mainfrom
chloggen go tool for managing the changelog#637joaopgrassi merged 22 commits intoopen-telemetry:mainfrom
Conversation
Member
Author
|
Here is a preview of a CHANGELOG file generated by the new tool (with dummy changelog entries) vTODO🛑 Breaking changes 🛑
💡 Enhancements 💡
🧰 Bug fixes 🧰
|
jsuereth
reviewed
Jan 11, 2024
Contributor
jsuereth
left a comment
jsuereth
left a comment
There was a problem hiding this comment.
Generally LGTM, just a question on some of the CONTRIBUTING refactoring.
joaopgrassi
changed the title
chloggen go tool for managing changelogchloggen go tool for managing the changelog
joaopgrassi
commented
Jan 12, 2024
Member
Author
|
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. |
joaopgrassi
changed the title
chloggen go tool for managing the changelogchloggen go tool for managing the changelog
joaopgrassi
changed the title
chloggen go tool for managing the changelogchloggen go tool for managing the changelog
trisch-me
reviewed
Jan 18, 2024
trisch-me
approved these changes
Jan 18, 2024
Contributor
trisch-me
left a comment
trisch-me
left a comment
There was a problem hiding this comment.
thanks for working on it!
jsuereth
approved these changes
Jan 24, 2024
arminru
reviewed
Feb 2, 2024
arminru
reviewed
Feb 2, 2024
arminru
approved these changes
Feb 2, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.