Add scripts to automate GitHub releases

[whymarrh]

This PR updates our CircleCI configuration, adding new 1 new job and 1 new workflow to automate parts of our release process. The work here ultimately results in a GitHub Release with the artifacts from npm run dist attached.

The Workflow

The high-level workflow is:

• A version branch is created off of develop
  1. CI sets the manifest version and commits that
  2. CI creates a Pull Request for the version
• When the Pull Request gets merged, CI creates a tag and GitHub Release for the commit

I've been playing around with the configuration on my fork, if you want to look at the CI builds for that repository:

• An example set of version branch builds: https://circleci.com/workflow-run/375c708c-9ae9-4264-9815-0ead4e3055b6
• An example develop build: https://circleci.com/workflow-run/83240798-7fea-4d4c-811f-e45cb2202618

Step 1: Creating a RC Pull Request

End result: a pull request for the version is created

Process: when a branch is created matching ^Version-v\d+[.]\d+[.]\d+, a CI job will use the version number from the branch name to update the version field in the manifest, and create a PR for that change. That PR can then be reviewed and updated as appropriate. When we go to merge the PR, we can squash+merge the changes into a single commit with the message Version vX.Y.Z.

Step 2: Creating a GitHub Release

End result: a release is created with the Chrome and Firefox builds attached

Process: when a commit to develop is made with a message matching ^Version v\d+[.]\d+[.]\d+. the CI build for that commit will include tagging it as vX.Y.Z and creating a release with the Chrome and Firefox builds as assets.

Unanswered Questions

• How do we want to deal with CHANGELOG.md? Scripts added to update the changelog
• Who should we set as reviewers on the RC PR? @MetaMask/extension-release-team

Tasks

• Set GITHUB_TOKEN and GITHUB_TOKEN_USER environment variables in CircleCI
• Double-check copy

Refs

• Closes Create automated Github Releases deploy script #3403
• Using Workflows to Schedule Jobs
• Configuring CircleCI

[danjm]

It would be nice to have an npm command that automates "Step 1: Creating a RC Pull Request". Should that fall within the scope of this PR?

[whymarrh]

It would be nice to have an npm command that automates "Step 1: Creating a RC Pull Request". Should that fall within the scope of this PR?

I don't think there's much there. We can literally create the branch on GitHub itself in a second.

[danfinlay]

A couple small questions.

Overall, looks awesome, definitely a few flags & commands that are new to me here.

Looks like it does stop short of automating the publication to the stores, which makes sense for now, as that's the most security sensitive bit. Since this PR excludes the most security critical piece, it seems generally safe to try out and see how we like it!

[whymarrh]

Task remaining on this PR:

• Rebase this
• Add reviewers to the created PR (@MetaMask/extension-release-team)
• Add a commit with the updated changelog headers to the PR
• Add the changelog contents to body of the GitHub release entry

[whymarrh]

• Add a commit with the updated changelog headers to the PR
• Add the changelog contents to body of the GitHub release entry

I've added d096ead and 56ddde7 to do exactly those things. I think the code here is ready for review and I'm going to give it a QA pass over on my fork. I'll update here when I've confirmed that this all works as I'd like it to.

[Gudahtt]

I believe release-bump-changelog-version needs to be made executable? All the scripts but that one are showing as +x for me

[whymarrh]

I'm giving this one more QA pass on my fork now, I'll leave a comment here when it's ready for review

[whymarrh]

Cool, I'm happy with where this is. I think this is good for another review. As it stands, this successfully creates a GitHub Release with the changelog and assets attached. You can see an example of the process on my fork:

1. The version pull request: Version v7.0.0 RC whymarrh/metamask-extension#22
2. The commit in particular with the updated manifest and changelog: whymarrh@4933fcd
3. The GitHub Release: Version 7.0.0

Note that the release contains all the lines in the changelog for the given version so we have the opportunity to add content both before and after the pull request is created.

Note as well that there is a slight but important difference between the name of the branches we currently use and the branches we'll need to use to trigger these scripts: there is a v prefix for the version number. Additionally, we should be using the Squash and merge option on the version pull request on GitHub to ensure that the commit message is formatted correctly.

cc @danfinlay @Gudahtt

[whymarrh]

I've added fdc2a7e as well to set the reviewer on the PR

[Gudahtt]

LGTM

[danfinlay]

Could we add your description of this flow (documentation of how to use these scripts) to our docs folder?

I also notice the line item:

• Set GITHUB_TOKEN and GITHUB_TOKEN_USER environment variables in CircleCI

Should these tokens be the @metamaskbot keys? I imagine it would be posting the PRs.

[whymarrh]

I also notice the line item:

• Set GITHUB_TOKEN and GITHUB_TOKEN_USER environment variables in CircleCI

Should these tokens be the @metamaskbot keys? I imagine it would be posting the PRs.

Yes, that'll be set once these are merged in, via the Circle CI config page.

Could we add your description of this flow (documentation of how to use these scripts) to our docs folder?

Sure can! I'll note here though that these scripts aren't run directly and are only for CI (they've got checks in place to make sure as well) so it'll be more documenting how to trigger these scripts.

[whymarrh]

I'm going to create a separate PR with some updates to the docs

[whymarrh]

Set GITHUB_TOKEN and GITHUB_TOKEN_USER environment variables in CircleCI

I've set these on CI:

Concerns addressed