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

Automate Changelog generation after each npm release #1312

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Conversation

adamziel
Copy link
Collaborator

@adamziel adamziel commented Apr 23, 2024

What is this PR doing?

Refreshes the Changelog after each npm package release.

This PR adds a new npm changelog script that runs in CI after npm packages are released. It is an adapted version of Gutenberg's changelog.js. It:

  • Composes a changelog section for the specified version tag based on merged GitHub PRs.
  • Blends that section into the existing CHANGELOG.md file, either replacing one of the sections or prepending a new one.
  • Gives props to contributors 🙌

This PR also ships a CHANGELOG.md file generated using the script.

Testing instructions

  1. Install Bun
  2. Run npm run changelog and confirm the CHANGELOG.md file gets updated with unreleased changes.

Related #1075

@adamziel adamziel requested a review from a team as a code owner April 24, 2024 11:15
@adamziel adamziel merged commit a4c2bba into trunk Apr 24, 2024
4 checks passed
@adamziel adamziel deleted the auto-changelog branch April 24, 2024 11:19
@adamziel
Copy link
Collaborator Author

adamziel commented Apr 24, 2024

Turns out I didn't add the scripts to this PR, they're here: https://github.com/WordPress/wordpress-playground/tree/trunk/packages/meta

@brandonpayton
Copy link
Member

This is great!

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.

2 participants