Release and Changelog workflow

Question

Release and Changelog workflow

adamziel opened this issue 2 years ago · 4 comments

Related to #768, let's provide clear communication about the changes in new versions of Playground. Changelogs and releases could be two useful tools for that.

Two super rough notes:

Maybe just a Changelog file? Or Gutenberg-like release script? Feed that into an automated changelog or do manual changelogs?
Woo – either manual changelog to match the branch name, OR section in the PR description that would automatically convert into a changelog entry. Then say “Fix”, “major”, “minor”, etc.

Answer 1 · 2024-03-01T10:30:58.000Z

Playground already has tagged npm package releases – Lerna automates that workflow
GitHub can autogenerate release notes based on a tag, and will even auto-append PR titles if you select another tag and click "Generate release notes" again

Answer 2 · 2024-03-01T10:32:19.000Z

Gutenberg has a script to automatically organize changelog entries into feature groups:

https://github.com/WordPress/gutenberg/blob/44b5cd5eb5974fdb5b9ad6e3212ac86d2f81e825/bin/plugin/commands/changelog.js#L741

Answer 3 · 2024-03-07T15:45:57.000Z

Open question: How to reconcile releases and changelogs with continuous deployments of playground.wordpress.net? Perhaps only do changelogs for npm packages?

Answer 4 · 2024-04-24T14:03:30.000Z

We now have an automated CHANGELOG.md. It's updated on every npm packages release, but we can also update it with unreleased changes using a GitHub action.