Project Management: Prompt user to link GitHub account to WordPress.org profile

package.json

@@ -110,6 +110,7 @@
 		"@wordpress/npm-package-json-lint-config": "file:packages/npm-package-json-lint-config",
 		"@wordpress/postcss-themes": "file:packages/postcss-themes",
 		"@wordpress/prettier-config": "file:packages/prettier-config",
+		"@wordpress/project-management-automation": "file:packages/project-management-automation",
 		"@wordpress/scripts": "file:packages/scripts",
 		"babel-loader": "8.0.6",
 		"babel-plugin-emotion": "10.0.27",

packages/project-management-automation/CHANGELOG.md

@@ -3,6 +3,11 @@
 ### New feature
 
 - Include TypeScript type declarations ([#18942](https://github.com/WordPress/gutenberg/pull/18942))
+- The "Add First Time Contributor Label" task now prompts the user to link their GitHub account to their WordPress.org profile if neccessary for props credit.
+
+### Improvements
+
+- The "Add First Time Contributor Label" task now runs retroactively on pushes to master, due to [permission constraints](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token) of GitHub Actions.
 
 ## 1.0.0 (2019-08-29)
 

packages/project-management-automation/README.md

@@ -2,7 +2,7 @@
 
 This is a [GitHub Action](https://help.github.com/en/categories/automating-your-workflow-with-github-actions) which contains various automation to assist with managing the Gutenberg GitHub repository:
 
-- `add-first-time-contributor-label`: Adds the 'First Time Contributor' label to PRs opened by contributors that have not yet made a commit.
+- `add-first-time-contributor-label`: Adds the 'First Time Contributor' label to PRs merged on behalf of contributors that have not previously made a contribution, and prompts the user to link their GitHub account to their WordPress.org profile if neccessary for props credit.
 - `add-milestone`: Assigns the correct milestone to PRs once merged.
 - `assign-fixed-issues`: Assigns any issues 'fixed' by a newly opened PR to the author of that PR.
 

packages/project-management-automation/lib/add-first-time-contributor-label.js

@@ -1,50 +1,131 @@
+/**
+ * External dependencies
+ */
+const got = /** @type {*} */ ( require( 'got' ) ); // See: https://github.com/sindresorhus/got/issues/1137
+
 /**
  * Internal dependencies
  */
 const debug = require( './debug' );
+const getAssociatedPullRequest = require( './get-associated-pull-request' );
 
 /** @typedef {import('@actions/github').GitHub} GitHub */
-/** @typedef {import('@octokit/webhooks').WebhookPayloadPullRequest} WebhookPayloadPullRequest */
+/** @typedef {import('@octokit/webhooks').WebhookPayloadPush} WebhookPayloadPush */
+/** @typedef {import('./get-associated-pull-request').WebhookPayloadPushCommit} WebhookPayloadPushCommit */
+
+/**
+ * Base endpoint URL for WordPress.org profile lookup by GitHub username.
+ *
+ * @type {string}
+ */
+const BASE_PROFILE_LOOKUP_API_URL =
+	'https://profiles.wordpress.org/wp-json/wporg-github/v1/lookup/';
+
+/**
+ * Message of comment prompting contributor to link their GitHub account from
+ * their WordPress.org profile for props credit.
+ *
+ * @type {string}
+ */
+const ACCOUNT_LINK_PROMPT =
+	'Congratulations on your first merged pull request! We would like to ' +
+	'give you credit for your contribution in the next WordPress release, but ' +
+	'we were unable to find a WordPress.org profile associated with your ' +
+	'GitHub account. At your convenience, please visit the following URL and ' +
+	'click "link your GitHub account" under "GitHub Username" to initiate ' +
+	'the process to link your accounts:\n\nhttps://profiles.wordpress.org/me/profile/edit/\n\n' +
+	'If you do not have a WordPress.org account, you can create one at the ' +
+	'following page:\n\nhttps://login.wordpress.org/register';
 
 /**
- * Adds the 'First Time Contributor' label to PRs opened by contributors that
- * have not yet made a commit.
+ * Adds the 'First Time Contributor' label to PRs merged on behalf of
+ * contributors that have not yet made a commit.
  *
- * @param {WebhookPayloadPullRequest} payload Pull request event payload.
- * @param {GitHub}                    octokit Initialized Octokit REST client.
+ * @param {WebhookPayloadPush} payload Push event payload.
+ * @param {GitHub}             octokit Initialized Octokit REST client.
  */
 async function addFirstTimeContributorLabel( payload, octokit ) {
-	const owner = payload.repository.owner.login;
-	const repo = payload.repository.name;
-	const author = payload.pull_request.user.login;
+	if ( payload.ref !== 'refs/heads/master' ) {
+		debug(
+			'add-first-time-contributor-label: Commit is not to `master`. Aborting'
+		);
+		return;
+	}
+
+	const commit =
+		/** @type {WebhookPayloadPushCommit} */ ( payload.commits[ 0 ] );
+	const pullRequest = getAssociatedPullRequest( commit );
+	if ( ! pullRequest ) {
+		debug(
+			'add-first-time-contributor-label: Cannot determine pull request associated with commit. Aborting'
+		);
+		return;
+	}
 
+	const repo = payload.repository.name;
+	const owner = payload.repository.owner.login;
+	const author = commit.author.username;
 	debug(
 		`add-first-time-contributor-label: Searching for commits in ${ owner }/${ repo } by @${ author }`
 	);
 
-	const {
-		data: { total_count: totalCount },
-	} = await octokit.search.commits( {
-		q: `repo:${ owner }/${ repo }+author:${ author }`,
+	const { data: commits } = await octokit.repos.listCommits( {
+		owner,
+		repo,
+		author,
 	} );
 
-	if ( totalCount !== 0 ) {
+	if ( commits.length > 1 ) {
 		debug(
-			`add-first-time-contributor-label: ${ totalCount } commits found. Aborting`
+			`add-first-time-contributor-label: Not the first commit for author. Aborting`
 		);
 		return;
 	}
 
 	debug(
-		`add-first-time-contributor-label: Adding 'First Time Contributor' label to issue #${ payload.pull_request.number }`
+		`add-first-time-contributor-label: Adding 'First Time Contributor' label to issue #${ pullRequest }`
 	);
 
 	await octokit.issues.addLabels( {
 		owner,
 		repo,
-		issue_number: payload.pull_request.number,
+		issue_number: pullRequest,
 		labels: [ 'First-time Contributor' ],
 	} );
+
+	debug(
+		`add-first-time-contributor-label: Checking for WordPress username associated with @${ author }`
+	);
+
+	let dotOrgUsername;
+	try {
+		const response = await got(
+			BASE_PROFILE_LOOKUP_API_URL + author,
+			/** @type {import('got').Options} */ ( {
+				responseType: 'json',
+			} )
+		);
+		dotOrgUsername = response.body.slug;
+	} catch ( error ) {
+		debug(
+			`add-first-time-contributor-label: Error retrieving from profile API:\n\n${ error.toString() }`
+		);
+		return;
+	}
+
+	if ( dotOrgUsername ) {
+		debug(
+			`add-first-time-contributor-label: User already known as ${ dotOrgUsername }. No need to prompt for account link!`
+		);
+		return;
+	}
+
+	await octokit.issues.createComment( {
+		owner,
+		repo,
+		issue_number: pullRequest,
+		body: ACCOUNT_LINK_PROMPT,
+	} );
 }
 
 module.exports = addFirstTimeContributorLabel;

packages/project-management-automation/lib/add-milestone.js

@@ -2,6 +2,7 @@
  * Internal dependencies
  */
 const debug = require( './debug' );
+const getAssociatedPullRequest = require( './get-associated-pull-request' );
 
 /** @typedef {import('@octokit/rest').HookError} HookError */
 /** @typedef {import('@actions/github').GitHub} GitHub */
@@ -45,8 +46,7 @@ async function addMilestone( payload, octokit ) {
 		return;
 	}
 
-	const match = payload.commits[ 0 ].message.match( /\(#(\d+)\)$/m );
-	const prNumber = match && match[ 1 ];
+	const prNumber = getAssociatedPullRequest( payload.commits[ 0 ] );
 	if ( ! prNumber ) {
 		debug( 'add-milestone: Commit is not a squashed PR. Aborting' );
 		return;

packages/project-management-automation/lib/get-associated-pull-request.js

@@ -0,0 +1,39 @@
+/**
+ * @typedef WebhookPayloadPushCommitAuthor
+ *
+ * @property {string} name     Author name.
+ * @property {string} email    Author email.
+ * @property {string} username Author username.
+ */
+
+/**
+ * Minimal type detail of GitHub Push webhook event payload, for lack of their
+ * own.
+ *
+ * TODO: If GitHub improves this on their own webhook payload types, this type
+ * should no longer be necessary.
+ *
+ * @typedef {Record<string,*>} WebhookPayloadPushCommit
+ *
+ * @property {string}                         message Commit message.
+ * @property {WebhookPayloadPushCommitAuthor} author  Commit author.
+ *
+ * @see https://developer.github.com/v3/activity/events/types/#pushevent
+ */
+
+/**
+ * Given a commit object, returns a promise resolving with the pull request
+ * number associated with the commit, or null if an associated pull request
+ * cannot be determined.
+ *
+ * @param {WebhookPayloadPushCommit} commit Commit object.
+ *
+ * @return {number?} Pull request number, or null if it cannot be
+ *                            determined.
+ */
+function getAssociatedPullRequest( commit ) {
+	const match = commit.message.match( /\(#(\d+)\)$/m );
+	return match && Number( match[ 1 ] );
+}
+
+module.exports = getAssociatedPullRequest;

packages/project-management-automation/lib/index.js

@@ -42,9 +42,8 @@ const automations = [
 		task: ifNotFork( assignFixedIssues ),
 	},
 	{
-		event: 'pull_request',
-		action: 'opened',
-		task: ifNotFork( addFirstTimeContributorLabel ),
+		event: 'push',
+		task: addFirstTimeContributorLabel,
 	},
 	{
 		event: 'push',