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

Restrict modification of changelog at PR #1682

Closed
XSAM opened this issue Mar 9, 2021 · 4 comments · Fixed by #5560
Closed

Restrict modification of changelog at PR #1682

XSAM opened this issue Mar 9, 2021 · 4 comments · Fixed by #5560
Assignees
Labels
pkg:tooling Related to the tooling package
Milestone

Comments

@XSAM
Copy link
Member

XSAM commented Mar 9, 2021

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

@XSAM XSAM added release:after-ga pkg:tooling Related to the tooling package labels Mar 9, 2021
@punya
Copy link
Member

punya commented Mar 9, 2021

Should we consider adopting https://www.conventionalcommits.org/ to generate the changelog automatically from commit messages?

@XSAM
Copy link
Member Author

XSAM commented Mar 11, 2021

The first thought in my head is only allowing the change to happen in the Unreleased section, which needs write a tool to parse markdown.

@punya
Copy link
Member

punya commented Mar 11, 2021

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.

@XSAM
Copy link
Member Author

XSAM commented Mar 12, 2021

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. ;)

@MrAlias MrAlias added help wanted Extra attention is needed and removed release:after-1.0 labels May 3, 2022
@XSAM XSAM self-assigned this Jun 28, 2024
@XSAM XSAM removed the help wanted Extra attention is needed label Jun 28, 2024
@XSAM XSAM closed this as completed in #5560 Jul 8, 2024
@XSAM XSAM closed this as completed in 30ca54a Jul 8, 2024
pellared pushed a commit that referenced this issue Jul 12, 2024
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
@MrAlias MrAlias added this to the v1.29.0 milestone Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg:tooling Related to the tooling package
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants