-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Restrict modification of changelog at PR #1682
Comments
Should we consider adopting https://www.conventionalcommits.org/ to generate the changelog automatically from commit messages? |
The first thought in my head is only allowing the change to happen in the |
Ah, that's a great idea and much less intrusive. As an alternative, could we keep the unreleased changes section in a separate file, and move it into the CHANGELOG as part of the release process? The tooling would be easier and contributors would be less likely to make a mistake. However, it would be slightly more work for maintainers at release time. |
Yeah, that seems a good approach too. But I slightly prefer to write more codes and be less intrusive. Furthermore, we might consider making this tool used by every OpenTelemetry repo in the feature if it is actually useful and essential. ;) |
related #1682 The previous implementation on #5560 has a bug (it works on my mac though) where it cannot recognize the released section correctly and pass every modification to the changelog file. This PR fixes the issue. Action result if we changed the unreleased section: ab9eecb Action result if we changed the released section: c751dc1
It's scary that we accidentally change the released section of the changelog at PR, which will mess our release notes and confuse users.
It might be a good solution to write a tool to prevent this change in the changelog and integrate it into the CI, which lowers reviewers' mental burden.
Prior fix to the changelog #1680
The text was updated successfully, but these errors were encountered: