Release Automation #312

Activity

1. lholmquist

   added

   chore/actionsChanges or additions to GitHub Workflow actionsChanges or additions to GitHub Workflow actions

   module/docsModule documentation changesModule documentation changes

   module/releasesPertaining to releases of the modulePertaining to releases of the module

   type/questionFurther information is requestedFurther information is requested

   on Aug 11, 2020
2. dazuma commented on Aug 11, 2020

   

   dazuma

   on Aug 11, 2020

   Member

   More actions

   We could consider a process like https://github.com/googleapis/release-please which was developed by the people behind conventional commits and is currently being used at Google to automate releases for hundreds of API client libraries across many languages. (Full disclosure: my day job is on that team.)

   The basic idea is to

   • trigger (e.g. a GH action) on new commits
   • interpret conventional commit messages to determine the correct semantic version bump (patch/minor/major)
   • generate changelogs automatically based on the same conventional commit messages
   • automatically open a PR with the version bump and changelog (and automatically update it as more commits are added)
   • then, once a human decides to do a release, they merge the PR (and of course they have the option to edit the version/changelog manually if desired)
   • a separate process can then trigger on that PR merge, and perform the release, i.e. creating a GH release, building a package, and publishing to npm
3. lance commented on Aug 17, 2020

   

   lance

   on Aug 17, 2020

   Member

   More actions

   @dazuma this is pretty interesting. We already have steps 1-3 in place. Steps 4-6 are essentially what @grant suggested here and what prompted the creation of this issue. I wasn't aware of release-please, however. Thanks for the pointer.
4. lholmquist commented on Aug 17, 2020

   

   lholmquist

   on Aug 17, 2020

   ContributorAuthor

   More actions

   this workflow looks really nice. the only problem I can see is the 2FA for npm. in the release-please docs, https://github.com/googleapis/release-please#automating-publication-to-npm , it says to "keep 2FA enable, point the the registry url to your own wombat dressing room". So in order to use that, we would need to have that running and hosted somewhere.
5. lance commented on Aug 25, 2020

   

   lance

   on Aug 25, 2020

   Member

   More actions

   As discussed on Slack, let's go ahead and try to get release-please in place without automated publishing to npm for the next release (3.2.0).
6. lholmquist commented on Aug 27, 2020

   

   lholmquist

   on Aug 27, 2020

   Last edited by lholmquist

   ContributorAuthor

   More actions

   I started to play around with adding release-please to my fork. For the most part, I like what it is doing, and it does all the things we are looking to automate, but there are a couple things that I think we need to fix before we can add it .

   This first is that it is not taking into account that my default branch is main instead of master. so all PR's have been going to master. I did add in the action before i switched my default branch, so maybe that is an issue, but i will test it again

   edit: I was using a old version and the latest version of the action works fine with main

   The second is that in our package.json, we have rules setup for standard-release that unhide certain commit message types, so they show in the changelog. It doesn't look like at the moment this can be done with release-please.

   We also need to make sure we are signing the release PR, which we could do manually once it is approved, but that would defeat the purpose of using automation.

   I'll see if I can add these things in and either send a PR, or create our own fork of it.
7. lance commented on Aug 27, 2020

   

   lance

   on Aug 27, 2020

   Member

   More actions

   I started to play around with adding release-please to my fork. For the most part, I like what it is doing, and it does all the things we are looking to automate, but there are a couple things that I think we need to fix before we can add it .

   Thanks for looking into this @lholmquist. I poked around the source for the project and found some things that might help.

   edit: if i have no master branch, the action fails, so it must be looking for master

   It looks like you can add a default-branch parameter to set the branch to main.

   The second is that in our package.json, we have rules setup for standard-release that unhide certain commit message types, so they show in the changelog. It doesn't look like at the moment this can be done with release-please.

   You might try extracting the standard-version stanza from package.json and put it into a conventional changelog config file.
8. lholmquist commented on Aug 27, 2020

   

   lholmquist

   on Aug 27, 2020

   ContributorAuthor

   More actions

   It looks like you can add a default-branch parameter to set the branch to main.

   I was using an old version, since i copy/pasted, latest version is fine now
9. bcoe commented on Aug 27, 2020

   

   bcoe

   on Aug 27, 2020

   Last edited by bcoe

   More actions

   Just catching up on this thread, I wanted to share this with you:

   https://github.com/GoogleCloudPlatform/release-please-action

   It's a GitHub action that runs release-please, here it is in action. The main reason I opt for the GitHub app, rather than the action, for Google projects is related to CLA.
10. lholmquist commented on Aug 27, 2020

    

    lholmquist

    on Aug 27, 2020

    ContributorAuthor

    More actions

    @bcoe thanks, that's actually the action text that i ended up copying and running into the master/main issue

    👍React with 👍1Reacted by Benjamin E. Coe
11. lholmquist commented on Aug 27, 2020

    

    lholmquist

    on Aug 27, 2020

    ContributorAuthor

    More actions

    @bcoe something I wanted to ask. Is it possible to have the release-please action use a standard-release config to show more types in the changelog? I've tried to add a .versionrc.json with something like this:

    {
      types: [
        type: ....
      ]
    }
    

    but i don't think it is recognizing it. It is also completely possible, I've written the config file incorrectly
12. bcoe commented on Aug 28, 2020

    

    bcoe

    on Aug 28, 2020

    More actions

    @lholmquist it's not today, but I'd be happy to add this functionality. If you get a moment, perhaps log a feature request? It's my goal that release-please would replace be able to replace standard-version (which I have had next to no time to work on in the past year, whereas I'm actively developing release-please).
13. lholmquist commented on Sep 2, 2020

    

    lholmquist

    on Sep 2, 2020

    Last edited by lholmquist

    ContributorAuthor

    More actions

    @bcoe sorry for the reply delay, i was on PTO.

    I can send a PR soon. I have something working on my fork. It looks like it needs to be updated in 2 spots. The GH action and the underlying release-please module

    👍React with 👍1Reacted by Benjamin E. Coe
14. bcoe commented on Sep 2, 2020

    

    bcoe

    on Sep 2, 2020

    More actions

    awesome, thank you @lholmquist that will be a great feature.
15. lholmquist commented on Sep 10, 2020

    

    lholmquist

    on Sep 10, 2020

    ContributorAuthor

    More actions

    @bcoe not sure if you are part of the group that does the release please GH action, but i also sent a PR there to use the updated release-please functionality that i added, googleapis/release-please-action#64
16. bcoe commented on Sep 10, 2020

    

    bcoe

    on Sep 10, 2020

    More actions

    @lholmquist I have released release-please-action@v2.2.0, let me know if everything works for you?
17. lholmquist commented on Sep 17, 2020

    

    lholmquist

    on Sep 17, 2020

    ContributorAuthor

    More actions

    closing via #329 a9114b7
18. lholmquist

    closed this as completedon Sep 17, 2020