Bootstrap an automation tool #15699

youknowriad · 2019-05-17T11:27:40Z

We start to have a lot of manual tasks when performing plugin releases, npm releases, changelogs,... and all of these flows. I think we should invest some time automating these to avoid mistakes and I think it could be a huge gain in time ultimately.

To do so, I'd like us to change the "manual" required work from performing the task to checking that everything went well and confirming using an interactive CLI tool. This is obviously not an easy tool to build with all these flows but I'm confident it will bring more confidence and time gains.

I started looking at the plugin RC release process and bootstrapped a release-plugin-rc CLI tool. This flow is complex, this PR implements the following flow:

Checking the status of the branch and local changes.
Choosing the right version for the RC.
Creating the release branch.
Performing the bump (updated the files).
Committing the version bump changes.
Building the plugin zip.
Pushing the release branch and the git tag.
Creating a github release with the changelog and the zip.
Cherry-picking the version bump to master.

The process is covered entirely, we could push it a bit further and include slack notifications.

This tool uses under the hood some npm utilities (commander, inquirer, chalk, simplegit), this adds a small burden when performing npm install on the project so I considered whether this should be a separate package.json/tool independent from the repository that you can bootstrap when needed. (This could be an easy follow-up if ever this grows too much).

Thoughts?

Testing instructions

The best way to try this locally without touching the official repo is to:

1- Checkout this branch.
2- Change the value of the repoOwner variable (set your username instead of WordPress).
3- have a fork the Gutenberg repository.
4- Run the command bin/commander.js rc.

At that point, your forked repo should be updated with the release.

gziolo

This is cool. Let's merge it and start using it and refine as we discover issues :)

bin/commander.js

youknowriad · 2019-05-18T13:36:44Z

I updated this, this covers the whole RC process now 🎉
I added testing instructions to be able to test this without touching this repo

youknowriad · 2019-05-18T17:49:55Z

I noticed while developping this that it's hard to develop the script on the repo and have the script perform commits, releases.. on the same repo.

In the last commit, I'm using a separate clone of the repository to perform all the release taks. This has a few of advantages:

Make it easy to develop and try the tool
Avoid conflicts with existing uncommited changes... the repo is kept untouched
Makes it easy to extract as a separate tool later.

youknowriad · 2019-05-21T08:55:39Z

Anyone willing to give this a try before I move forward and merge it. It should be easy to test on a fork (see testing instructions)

aduth · 2019-05-23T17:35:01Z

bin/build-plugin-zip.sh

-		git clean -xdf
-	else
-		error "Fair enough; aborting. Tidy up your repo and try again. 🙂"
+if [ -z "$NO_CHECKS" ]; then


Aside: I'm happy to see this change, and had planned to propose similarly, for benefit of gutenberg.run, where I implemented my own custom version of this script to skip these steps, as they'd been slow to execute in containers, and unnecessary for fresh clones.

bin/commander.js

aduth · 2019-05-23T17:39:34Z

bin/commander.js

+const packageLockPath = workingDirectoryPath + '/package-lock.json';
+const pluginFilePath = workingDirectoryPath + '/gutenberg.php';
+const gutenbergZipPath = workingDirectoryPath + '/gutenberg.zip';
+const repoOwner = 'WordPress';


Per testing instructions, if part of the point of making this a variable is for configurability, should we open up that configurability as an environment variable?

Suggested change

const repoOwner = 'WordPress';

const { REPO_OWNER: repoOwner = 'WordPress' } = process.env;

I'm hesitant to introduce this now. I think there's value in it but down the road, we're going to touch SVN repos as well. Will we need an env variable for that repo as well. Ideally we'd have a consistent pattern to ease testing in fake environments. Maybe a single config file?

bin/commander.js

aduth · 2019-05-23T17:58:22Z

bin/commander.js

+			const { token } = await inquirer.prompt( [ {
+				type: 'input',
+				name: 'token',
+				message: 'Please provide a Github personal authentication token. (Navigate to ' + success( 'https://github.com/settings/tokens' ) + ' to create one with admin:org, repo and write:packages rights)',


You can simplify this further by specifying scopes as query argument:

https://github.com/settings/tokens/new?scopes=repo,admin:org,write:packages

Suggested change

message: 'Please provide a Github personal authentication token. (Navigate to ' + success( 'https://github.com/settings/tokens' ) + ' to create one with admin:org, repo and write:packages rights)',

message: 'Please provide a GitHub personal authentication token. Navigate to ' + success( 'https://github.com/settings/tokens/new?scopes=repo,admin:org,write:packages' ) + ' to create one.',

Are we using the packages feature? 🤔

At some point, it would be nice to remember this, or use credentials from OS. I think I've used (or authored?) packages before which integrate with the OS password vault to retrieve credentials.

I don't think we are, but I think for the "roles", GitHub considers the releases as packages. Without that right, I had errors.

bin/commander.js

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

youknowriad · 2019-05-24T07:56:01Z

This should be ready, I'm going to merge this later today to be able to use it for the next release.

gziolo

It works like a charm. I was able to go through all steps. This is the result of my test run:

https://github.com/gziolo/gutenberg/releases/tag/v5.8.0-rc.1

This is pure gold. I love all the bits of this script. My favorite part is that it operates on fresh clone of the repo so it doesn't remove my project configuration in IDE 🎉

gziolo · 2019-05-24T11:49:11Z

By the way, let's add a note in release notes to make sure people use it :)

youknowriad · 2019-05-24T16:20:28Z

By the way, let's add a note in release notes to make sure people use it :)

I'll do it once we figure out the whole process.

Bootstrap an automation tool

03545b0

youknowriad added [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Project Management Meta-issues related to project management of Gutenberg labels May 17, 2019

youknowriad requested review from aduth, ajitbohra, gziolo, nerrad, oandregal and ntwb as code owners May 17, 2019 11:27

youknowriad self-assigned this May 17, 2019

youknowriad added [Type] Build Tooling Issues or PRs related to build tooling and removed [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. labels May 17, 2019

youknowriad added 3 commits May 17, 2019 13:04

Checking the current branch

831f54e

Check uncommited local changes

efd6949

Add the creation of the release branch and the version bump commit

628c417

gziolo reviewed May 17, 2019

View reviewed changes

bin/commander.js Outdated Show resolved Hide resolved

youknowriad added 9 commits May 17, 2019 14:37

Adding simple git dependency

24abc67

Clean the working tree

9a56a01

Support building the plugin zip

9180cf2

Support building the zip

4c3b5ee

Adding a welcome message

e4a344b

Consistency for the confirmation messages

4fd4090

Better error handling

8c689a7

Creating the release tag

180207c

Add the GitHub release and the remote branch/tag

ba3f0d9

Update the release CLI to use a separate repo clone

581960c

Small optimizations

d20945d

youknowriad requested a review from a team May 21, 2019 08:56

aduth reviewed May 23, 2019

View reviewed changes

youknowriad and others added 8 commits May 23, 2019 23:08

Fix typo

1c21635

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Fix typo

9c3f8e5

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Improve the token message

f74b3d7

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Fix Typo

950d17a

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Fix typo

2c6f3c1

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Fix typo

fd6a196

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Reorganize the file and add comments

6649f26

Fix debug artifact

65a7674

gziolo approved these changes May 24, 2019

View reviewed changes

gziolo mentioned this pull request May 24, 2019

WIP: Create WP Plugin #10628

Closed

youknowriad merged commit e81f191 into master May 24, 2019

youknowriad deleted the add/automation-tool branch May 24, 2019 16:21

youknowriad added this to the 5.8 (Gutenberg) milestone May 27, 2019

aduth mentioned this pull request Jun 10, 2019

Build Tooling: Optimize build by caching results #15967

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bootstrap an automation tool #15699

Bootstrap an automation tool #15699

youknowriad commented May 17, 2019 •

edited

gziolo left a comment

youknowriad commented May 18, 2019

youknowriad commented May 18, 2019

youknowriad commented May 21, 2019

aduth May 23, 2019

aduth May 23, 2019

youknowriad May 23, 2019

aduth May 23, 2019

aduth May 23, 2019

youknowriad May 23, 2019

youknowriad commented May 24, 2019

gziolo left a comment

gziolo commented May 24, 2019

youknowriad commented May 24, 2019

	const repoOwner = 'WordPress';
	const { REPO_OWNER: repoOwner = 'WordPress' } = process.env;

	message: 'Please provide a Github personal authentication token. (Navigate to ' + success( 'https://github.com/settings/tokens' ) + ' to create one with admin:org, repo and write:packages rights)',
	message: 'Please provide a GitHub personal authentication token. Navigate to ' + success( 'https://github.com/settings/tokens/new?scopes=repo,admin:org,write:packages' ) + ' to create one.',

Bootstrap an automation tool #15699

Bootstrap an automation tool #15699

Conversation

youknowriad commented May 17, 2019 • edited

gziolo left a comment

Choose a reason for hiding this comment

youknowriad commented May 18, 2019

youknowriad commented May 18, 2019

youknowriad commented May 21, 2019

aduth May 23, 2019

Choose a reason for hiding this comment

aduth May 23, 2019

Choose a reason for hiding this comment

youknowriad May 23, 2019

Choose a reason for hiding this comment

aduth May 23, 2019

Choose a reason for hiding this comment

aduth May 23, 2019

Choose a reason for hiding this comment

youknowriad May 23, 2019

Choose a reason for hiding this comment

youknowriad commented May 24, 2019

gziolo left a comment

Choose a reason for hiding this comment

gziolo commented May 24, 2019

youknowriad commented May 24, 2019

youknowriad commented May 17, 2019 •

edited