Automate release notes generation #6187

pierlon · 2021-05-08T10:01:39Z

Summary

This PR adds a custom GHA that will create (or update) a release draft for the specified branch and milestone. A new GHA workflow has also been added that allows one to manually trigger the action.

The release name and tag are derived from amp.php, and the release notes are generated from the given milestone.

The action also provides an output called asset_upload_url, that would allow other GHA jobs to upload release assets to the created release (which we can use to upload a production build of the plugin, for example).

Screenshots

What it would look like when triggering the workflow:
An example of what the action logs:
An example of a draft release:

Checklist

My code is tested and passes existing tests.
My code follows the Engineering Guidelines (updates are often made to the guidelines, check it out periodically).

pierlon · 2021-05-08T11:41:07Z

The "Release Drafter / Update release draft" workflow is failing because the necessary config is not yet on the develop branch. One of the developers of the Action stated it's a known limitation (release-drafter/release-drafter#398 (comment)):

This is a limitation inside probot this is properly intended behavior so that somebody cannot introduce something from a pull requests or from a branch.

github-actions · 2021-06-29T15:11:25Z

Plugin builds for 3c87818 are ready 🛎️!

Download development build
Download production build

…nt/5520-release-automation * 'develop' of github.com:ampproject/amp-wp: Fix test_get_mu_plugins_data for WP 5.8 (#6434) Rename prop Remove the QA Tester plugin Bump eslint from 7.28.0 to 7.29.0 See if removing the expression syntax allows for the step conditionals to be evaluated correctly Update Gutenberg package dependencies Add test for amp-render[template] Update amphtml spec to 2106240350000 Bump sirbrillig/phpcs-variable-analysis in /qa-tester Bump optimize-css-assets-webpack-plugin from 6.0.0 to 6.0.1 Bump eslint-plugin-jsdoc from 34.6.1 to 35.4.0

pierlon · 2021-06-30T21:48:24Z

I've added a npm script to allow for the release changelog to be generated locally as well. The only caveat is that you would need a GitHub PAT (with the permissions public_repo, read:org, read:user, repo:status, user:email) in order access GitHub's GraphQL API.

The script accepts the milestone to generate the changelog for and gets the token from the GITHUB_TOKEN environment variable. The current syntax to run the script is (assuming GITHUB_TOKEN environment variable has already been set):

npm run generate-changelog -- <milestone name>

westonruter · 2021-07-19T23:32:20Z

bin/release-changelog/index.js

+
+const milestone = process.argv[ 2 ];
+
+const token = process.env.GITHUB_TOKEN;


If token is empty, should this raise an error to inform the user to add it to their environment?

Yea that makes sense. I've added some logic to properly parse the args and validate them in 312f0d3.

westonruter · 2021-07-19T23:36:24Z

.github/actions/draft-release/action.yml

+    description: 'The URL for uploading assets to the release'
+runs:
+  using: 'node12'
+  main: 'dist/index.js'


Where does this file come from? Forgive my ignorance.

Oh, nevermind. It comes from npm run build for this sub-package.

westonruter · 2021-07-19T23:48:29Z

.github/actions/draft-release/src/index.js

+		if (matches && matches[1]) {
+			[, tagName] = matches;
+		}


Suggested change

if (matches && matches[1]) {

[, tagName] = matches;

}

if (!matches || !matches[1]) {

throw new Error( 'Unable to parse Version from plugin bootstrap PHP file.' );

}

tagName = matches[1];

westonruter · 2021-07-19T23:50:38Z

.github/actions/draft-release/src/index.js

+		if (matches && matches[1]) {
+			[, tagName] = matches;
+		}
+


It might be worthwhile to do some checking of the milestone to make sure it matches:

Suggested change

if ( ! tagName.startsWith( tagName.substr(1) ) ) {

throw new Error( "Milestone mismatch with PHP plugin bootsrap version." );

}

Done in 752872d.

westonruter · 2021-07-19T23:53:02Z

.github/actions/draft-release/src/utils/make_release.js

+			target_commitish: commitish
+		});
+		core.info(`Created ${tagName} release`);
+	} else {


This should check to see if release is a draft, and if not, throw an error. We don't want to accidentally update a previous release.

Done in 5b6e433.

# Conflicts: # package-lock.json # package.json

westonruter · 2021-09-14T23:15:49Z

Looking forward to seeing this in action!

# Conflicts: # package-lock.json

lgtm-com · 2021-09-15T01:02:25Z

This pull request introduces 1 alert when merging 1a89432 into 6822183 - view on LGTM.com

new alerts:

1 for Unsafe HTML constructed from library input

westonruter · 2021-09-15T23:39:56Z

This pull request introduces 1 alert when merging 1a89432 into 6822183 - view on LGTM.com

I guess this reflects an update to LGTM's audits, rather than a code change here. This PR didn't touch amp-customize-controls.js. I've marked the test failure as a false-positive since the contents are escaped using wp_kses_post().

So the package conflicts just have to be fixed… again. 😬

# Conflicts: # package-lock.json # package.json

lgtm-com · 2021-09-16T00:25:36Z

This pull request introduces 1 alert when merging 0c958d7 into 7dd4c1a - view on LGTM.com

new alerts:

1 for Unsafe HTML constructed from library input

pierlon · 2021-09-16T00:43:13Z

Hmm seems the error is back again. Wondering if it can be hidden permanently.

lgtm-com · 2021-09-16T01:06:51Z

This pull request introduces 1 alert when merging 718b950 into 7dd4c1a - view on LGTM.com

new alerts:

1 for Unsafe HTML constructed from library input

lgtm-com · 2021-09-16T01:14:11Z

This pull request introduces 1 alert when merging 3c87818 into 7dd4c1a - view on LGTM.com

new alerts:

1 for Unsafe HTML constructed from library input

pierlon · 2021-09-16T01:20:56Z

OK so according to the LGTM docs, one should be able to disable individual alerts by adding "suppression comments" to the source code, which I've done in 3c87818.

One thing to note from that same doc:

If you've enabled automated code review of pull requests for your projects, it's important to note that alert suppression changes made in a pull request are only applied when that pull request is merged. So, if you suppress an alert in a pull request, LGTM will continue to report the related alert for as long as the pull request is open.

So it's expected to still get alerts in the PR if the alert was disabled.

pierlon self-assigned this May 8, 2021

pierlon changed the title ~~Automate release management tasks~~ Automate release notes generation May 8, 2021

pierlon added the Infrastructure Changes impacting testing infrastructure or build tooling label May 8, 2021

Automate generation of release notes

5d2e6cf

pierlon force-pushed the enhancement/5520-release-automation branch from 667ca54 to 5d2e6cf Compare May 8, 2021 11:37

pierlon added 6 commits June 27, 2021 03:18

Merge branch 'develop' into enhancement/5520-release-automation

499a6e8

Limit release draft changelog generator to release branch being updated

162ee17

Add draft-release GHA

69d92c1

Hide diff for dist/index.js

05cca1f

Fix syntax

5819882

Fix making release

fd2a0ad

pierlon requested review from westonruter and schlessera June 29, 2021 15:01

pierlon marked this pull request as ready for review June 29, 2021 15:02

Don't hardcode repo name

81513c2

pierlon and others added 3 commits June 29, 2021 11:19

Pass repo name to class

d68ec22

Add npm script to generate release changelog

9613b0c

Ignore lint error

e1eab3b

westonruter requested changes Jul 19, 2021

View reviewed changes

pierlon added 5 commits September 1, 2021 19:09

Parse arguments and validate them

312f0d3

Check release is a draft before updating it

5b6e433

Verify milestone and tag name match

752872d

Merge branch 'develop' into enhancement/5520-release-automation

36e0871

# Conflicts: # package-lock.json # package.json

Update package-lock.json

6f88a29

pierlon added 2 commits September 14, 2021 20:56

Merge branch 'develop' into enhancement/5520-release-automation

723c9f8

# Conflicts: # package-lock.json

Update package-lock.json

1a89432

pierlon added 2 commits September 15, 2021 20:17

Merge branch 'develop' into enhancement/5520-release-automation

3efbadc

# Conflicts: # package-lock.json # package.json

Update package-lock.json

0c958d7

pierlon added 2 commits September 15, 2021 20:56

Update draft-release GHA binary

d1ccd88

Suppress LGTM alert

718b950

Try moving suppression to front of comment

3c87818

pierlon merged commit 26c3283 into develop Sep 16, 2021

pierlon deleted the enhancement/5520-release-automation branch September 16, 2021 01:22

westonruter unassigned pierlon Nov 11, 2021

westonruter modified the milestones: v2.2, v2.3 Dec 7, 2021

westonruter modified the milestones: v2.3, v2.4 Dec 23, 2021

westonruter modified the milestones: v2.4, v2.3 Feb 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automate release notes generation #6187

Automate release notes generation #6187

pierlon commented May 8, 2021 •

edited

Loading

pierlon commented May 8, 2021 •

edited

Loading

github-actions bot commented Jun 29, 2021 •

edited

Loading

pierlon commented Jun 30, 2021

westonruter Jul 19, 2021

pierlon Sep 2, 2021

westonruter Jul 19, 2021

westonruter Jul 19, 2021

westonruter Jul 19, 2021

westonruter Jul 19, 2021

pierlon Sep 2, 2021

westonruter Jul 19, 2021

pierlon Sep 2, 2021

westonruter commented Sep 14, 2021

lgtm-com bot commented Sep 15, 2021

westonruter commented Sep 15, 2021

lgtm-com bot commented Sep 16, 2021

pierlon commented Sep 16, 2021

lgtm-com bot commented Sep 16, 2021

lgtm-com bot commented Sep 16, 2021

pierlon commented Sep 16, 2021


		const milestone = process.argv[ 2 ];

		const token = process.env.GITHUB_TOKEN;

-		if (matches && matches[1]) {
-			[, tagName] = matches;
-		}
+		if (!matches || !matches[1]) {
+			throw new Error( 'Unable to parse Version from plugin bootstrap PHP file.' );
+		}
+		tagName = matches[1];

+	if ( ! tagName.startsWith( tagName.substr(1) ) ) {
+		throw new Error( "Milestone mismatch with PHP plugin bootsrap version." );
+	}

Automate release notes generation #6187

Automate release notes generation #6187

Conversation

pierlon commented May 8, 2021 • edited Loading

Summary

Screenshots

Checklist

pierlon commented May 8, 2021 • edited Loading

github-actions bot commented Jun 29, 2021 • edited Loading

pierlon commented Jun 30, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter commented Sep 14, 2021

lgtm-com bot commented Sep 15, 2021

westonruter commented Sep 15, 2021

lgtm-com bot commented Sep 16, 2021

pierlon commented Sep 16, 2021

lgtm-com bot commented Sep 16, 2021

lgtm-com bot commented Sep 16, 2021

pierlon commented Sep 16, 2021

pierlon commented May 8, 2021 •

edited

Loading

pierlon commented May 8, 2021 •

edited

Loading

github-actions bot commented Jun 29, 2021 •

edited

Loading