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

Make change log entries mandatory with every PR #988

Merged
merged 12 commits into from
Nov 21, 2024

Conversation

obenland
Copy link
Member

@obenland obenland commented Nov 12, 2024

It's a pretty barebones way to make sure changelogs get updated with every PR, instead of someone having to go through and doing it manually.
Adding the "Skip Changelog" to a PR will make the check pass, regardless of whether a changelog was updated or not.

Proposed changes:

  • Adds a Github action that checks CHANGELOG.md and readme.txt for updates.

@obenland obenland added the Skip Changelog Disables the "Changelog Updated" action for PRs where changelog entries are not necessary. label Nov 12, 2024
@obenland obenland removed the Skip Changelog Disables the "Changelog Updated" action for PRs where changelog entries are not necessary. label Nov 12, 2024
@github-actions github-actions bot added the Docs label Nov 12, 2024
@obenland
Copy link
Member Author

It looks like Gardening Bot adds the Docs label whenever Changelog gets updated :)

@pfefferle pfefferle requested a review from jeherve November 12, 2024 20:53
@pfefferle
Copy link
Member

yep ;)

@obenland obenland marked this pull request as ready for review November 12, 2024 20:59
@obenland obenland self-assigned this Nov 12, 2024
@obenland obenland changed the title Try: Mandatory change log entry Make change log entries mandatory with every PR Nov 12, 2024
pfefferle
pfefferle previously approved these changes Nov 12, 2024
Copy link
Member

@pfefferle pfefferle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it!

@jeherve
Copy link
Member

jeherve commented Nov 13, 2024

It looks like Gardening Bot adds the Docs label whenever Changelog gets updated :)

That's a bug! :) It shouldn't be happening, we designed the action to ignore changes to CHANGELOG.md:
Automattic/jetpack#30007 (comment)

I'll look into why that's happening and get this fixed.

Edit: PR is here:
Automattic/jetpack#40160

@jeherve
Copy link
Member

jeherve commented Nov 13, 2024

Maybe this is an opportunity to switch to using automattic/jetpack-changelogger to manage changelog entries and generation for this plugin?
https://packagist.org/packages/automattic/jetpack-changelogger

It is currently used in the Jetpack monorepo as well as in the WooCommerce monorepo, and can be used to generate single changelog entries for each PR, and then update a single changelog file on release.

Once the package is in use in the repo, it can be used from the command line when you're working on your PRs, or directly from the PR description, as you can see from the PR template in the WooCommerce repo:
https://github.com/woocommerce/woocommerce/blob/trunk/.github/PULL_REQUEST_TEMPLATE.md#changelog-entry

Is that something you'd be interested in? I'd be happy to set that up.

@pfefferle pfefferle self-requested a review November 20, 2024 12:20
pfefferle
pfefferle previously approved these changes Nov 20, 2024
@pfefferle
Copy link
Member

@obenland do you think this is ready to merge?

@obenland obenland requested a review from pfefferle November 21, 2024 13:49
@obenland
Copy link
Member Author

Looks likes it needs a new approval. Feel free to merge at your convenience

@pfefferle pfefferle merged commit 12883a5 into trunk Nov 21, 2024
22 checks passed
@pfefferle pfefferle deleted the add/changelog-enforcer branch November 21, 2024 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants