ParabolInc / parabol

Free online agile retrospective meeting tool
https://www.parabol.co/
Other
1.91k stars 331 forks source link

Automatically drafts next release notes as pull requests are merged into master #7196

Closed JimmyLv closed 2 years ago

JimmyLv commented 2 years ago

As a release owner, currently we have to manually create Release Changelog in Release Playbook. Also, being an open-source project, we don't integrate/use GitHub's Release and right now using the Markdown format CHANGELOG.md could not able to associate issue numbers and committers (at least not yet).

let's use the Release Please GitHub bot to have a try, automates CHANGELOG generation, the creation of GitHub releases, and version bumps for our project. image

ACs

edited: replace the Release-Drafter with Google Release Please

rafaelromcar-parabol commented 2 years ago

Why using Release-Drafter over Google Release Please? Release please also has a proposed Github action.

Dschoordsch commented 2 years ago

Added AC to not continue adding the conventional commit prefixes to the changelog

JimmyLv commented 2 years ago

@rafaelromcar-parabol Quick answer, I think that's why it's called Drafter, because my initial intention was just to generate the latest changes from the last release Tag 🤣 But thanks for introducing Google Release Please, I thought if we could do it in one step, it would be straightforward to do.

rafaelromcar-parabol commented 2 years ago

Yeah, Release Please looks great. I've been planning on testing it and I'll do it probably this week for one Terraform module, just to test it.

As it is suppose to do more than the Release-Drafter, would you like to test that with me and then decide which one to implement? Or you prefer me to enable Release-Drafter here anyway?

JimmyLv commented 2 years ago

After testing Release Please with Rafa at https://github.com/ParabolInc/terraform-module-parabol-gcp, it works really well and does a lot more. Unlike the Release-Drafter, it generates a PR with the release branch to automatically update the version number, which completely replaces the version changes we were doing manually in the staging branch. Next I will try to test the Node.js project for our main Parabol repository, especially for the monorepo typo, to see if it works equally well.