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

Add workflow to check for presence of CHANGELOG changes on PRs #1067

Merged
merged 2 commits into from
Sep 9, 2020

Conversation

Aneurysm9
Copy link
Member

Fixes #932.

@Aneurysm9
Copy link
Member Author

It looks like there may not be a way to mark the missing changelog as a warning rather than a failure. Thoughts on whether that's ok?

@MrAlias
Copy link
Contributor

MrAlias commented Aug 18, 2020

It looks like there may not be a way to mark the missing changelog as a warning rather than a failure. Thoughts on whether that's ok?

I think for 99% of PRs this will be fine. The times it will not will be for dependabot PRs (though this might be remediable), and administrative changes (changing approvers or maintainers is something I have been leaving out of the CHANGELOG as I didn't it relevant to the user).

I guess we could fix up the dependant stuff to add to the CHANGELOG and maybe also update this to see if the change was purely administrative (i.e. CODEOWNER was changed)? That or require CHANGELOG entries for the administrative stuff as well.

@evantorrie
Copy link
Contributor

I guess we could fix up the dependant stuff to add to the CHANGELOG and maybe also update this to see if the change was purely administrative (i.e. CODEOWNER was changed)? That or require CHANGELOG entries for the administrative stuff as well.

I'd be happy to do this (make dependencies auto-fix include adding to the changelog).

@Aneurysm9
Copy link
Member Author

I guess we could fix up the dependant stuff to add to the CHANGELOG and maybe also update this to see if the change was purely administrative (i.e. CODEOWNER was changed)? That or require CHANGELOG entries for the administrative stuff as well.

I'd be happy to do this (make dependencies auto-fix include adding to the changelog).

If it can add a Skip Changelog label to dependencies issues then this check would ignore it. I'm not sure how much value there is in including a list of dependency updates in the changelog. Perhaps as useful but less cluttering would be a link to a PR search for dependabot PRs merged since the prior release date.

@evantorrie
Copy link
Contributor

If it can add a Skip Changelog label to dependencies issues then this check would ignore it. I'm not sure how much value there is in including a list of dependency updates in the changelog. Perhaps as useful but less cluttering would be a link to a PR search for dependabot PRs merged since the prior release date.

I tend to agree that less clutter re: dependabot version upgrades would be a better choice - especially as the project matures.

I created #1113 to track adding a Skip Changelog label.

@evantorrie
Copy link
Contributor

@Aneurysm9 Could you create a "Skip Changelog" label with appropriate capitalization, etc?

I can then take on implementing #1113.

@Aneurysm9 Aneurysm9 added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Sep 9, 2020
@Aneurysm9
Copy link
Member Author

@Aneurysm9 Could you create a "Skip Changelog" label with appropriate capitalization, etc?

I can then take on implementing #1113.

Label created.

@Aneurysm9 Aneurysm9 requested a review from XSAM as a code owner September 9, 2020 00:46
@Aneurysm9 Aneurysm9 merged commit 1d21890 into open-telemetry:master Sep 9, 2020
evantorrie pushed a commit to evantorrie/opentelemetry-go that referenced this pull request Sep 10, 2020
@pellared pellared added this to the untracked milestone Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

automated advisory on CHANGELOG.md requirement
5 participants