prep build 02/22

Author: bph

bin/plugin/commands/changelog.js

@@ -541,9 +541,7 @@ function getEntry( issue ) {
 					title,
 					issue.number,
 					issue.html_url
-				) +
-				' - @' +
-				issue.user.login;
+				);
 }
 
 /**
@@ -683,7 +681,10 @@ async function fetchAllPullRequests( octokit, settings ) {
 function getChangelog( pullRequests ) {
 	let changelog = '## Changelog\n\n';
 
-	const groupedPullRequests = groupBy( pullRequests, getIssueType );
+	const groupedPullRequests = groupBy(
+		skipCreatedByBots( pullRequests ),
+		getIssueType
+	);
 
 	const sortedGroups = Object.keys( groupedPullRequests ).sort( sortGroup );
 
@@ -781,10 +782,6 @@ function sortFeatureGroups( featureGroups ) {
  */
 function getFirstTimeContributorPRs( pullRequests ) {
 	return pullRequests.filter( ( pr ) => {
-		if ( pr.user.type.toLowerCase() === 'bot' ) {
-			return false;
-		}
-
 		return pr.labels.find(
 			( { name } ) => name.toLowerCase() === 'first-time contributor'
 		);
@@ -799,7 +796,7 @@ function getFirstTimeContributorPRs( pullRequests ) {
  *
  * @return {string} The formatted markdown list of contributors and their PRs.
  */
-function getContributorMarkdownList( ftcPRs ) {
+function getContributorPropsMarkdownList( ftcPRs ) {
 	return ftcPRs.reduce( ( markdownList, pr ) => {
 		const title = getNormalizedTitle( pr.title, pr ) || '';
 
@@ -822,7 +819,7 @@ function getContributorMarkdownList( ftcPRs ) {
  * @return {IssuesListForRepoResponseItem[]} The sorted list of pull requests.
  */
 function sortByUsername( items ) {
-	return sortBy( items, ( item ) => item.user.login );
+	return sortBy( items, ( item ) => item.user.login.toLowerCase() );
 }
 
 /**
@@ -836,19 +833,32 @@ function getUniqueByUsername( items ) {
 }
 
 /**
- * Produces the formatted markdown for the full time contributors section of
- * the changelog output.
+ * Excludes users who should not be included in the changelog.
+ * Typically this is "bot" users.
+ *
+ * @param {IssuesListForRepoResponseItem[]} pullRequests List of pull requests.
+ * @return {IssuesListForRepoResponseItem[]} The list of filtered pull requests.
+ */
+function skipCreatedByBots( pullRequests ) {
+	return pullRequests.filter(
+		( pr ) => pr.user.type.toLowerCase() !== 'bot'
+	);
+}
+
+/**
+ * Produces the formatted markdown for the contributor props seciton.
  *
  * @param {IssuesListForRepoResponseItem[]} pullRequests List of pull requests.
  *
- * @return {string} The formatted contributors section.
+ * @return {string} The formatted props section.
  */
-function getContributors( pullRequests ) {
+function getContributorProps( pullRequests ) {
 	const contributorsList = flow( [
+		skipCreatedByBots,
 		getFirstTimeContributorPRs,
 		getUniqueByUsername,
 		sortByUsername,
-		getContributorMarkdownList,
+		getContributorPropsMarkdownList,
 	] )( pullRequests );
 
 	return (
@@ -860,6 +870,46 @@ function getContributors( pullRequests ) {
 	);
 }
 
+/**
+ *
+ * @param {IssuesListForRepoResponseItem[]} pullRequests List of first time contributor PRs.
+ * @return {string} The formatted markdown list of contributor usernames.
+ */
+function getContributorsMarkdownList( pullRequests ) {
+	return pullRequests
+		.reduce( ( markdownList = '', pr ) => {
+			markdownList += ` @${ pr.user.login }`;
+			return markdownList;
+		}, '' )
+		.trim();
+}
+
+/**
+ * Produces the formatted markdown for the full time contributors section of
+ * the changelog output.
+ *
+ * @param {IssuesListForRepoResponseItem[]} pullRequests List of pull requests.
+ *
+ * @return {string} The formatted contributors section.
+ */
+function getContributorsList( pullRequests ) {
+	const contributorsList = flow( [
+		skipCreatedByBots,
+		getUniqueByUsername,
+		sortByUsername,
+		getContributorsMarkdownList,
+	] )( pullRequests );
+
+	return (
+		'\n\n' +
+		'## Contributors' +
+		'\n\n' +
+		'The following contributors merged PRs in this release:' +
+		'\n\n' +
+		contributorsList
+	);
+}
+
 /**
  * Generates and logs changelog for a milestone.
  *
@@ -882,9 +932,14 @@ async function createChangelog( settings ) {
 		const pullRequests = await fetchAllPullRequests( octokit, settings );
 
 		const changelog = getChangelog( pullRequests );
-		const contributors = getContributors( pullRequests );
+		const contributorProps = getContributorProps( pullRequests );
+		const contributorsList = getContributorsList( pullRequests );
 
-		releaselog = releaselog.concat( changelog, contributors );
+		releaselog = releaselog.concat(
+			changelog,
+			contributorProps,
+			contributorsList
+		);
 	} catch ( error ) {
 		if ( error instanceof Error ) {
 			releaselog = formats.error( error.stack );
@@ -935,7 +990,9 @@ async function getReleaseChangelog( options ) {
 	getTypesByLabels,
 	getTypesByTitle,
 	getFormattedItemDescription,
-	getContributors,
+	getContributorProps,
+	getContributorsList,
 	getChangelog,
 	getUniqueByUsername,
+	skipCreatedByBots,
 };

bin/plugin/commands/packages.js

@@ -111,6 +111,8 @@ async function runWordPressReleaseBranchSyncStep(
  * @param {SemVer}      minimumVersionBump      Minimum version bump for the packages.
  * @param {ReleaseType} releaseType             Release type selected from CLI.
  * @param {string}      abortMessage            Abort Message.
+ *
+ * @return {?string}   The optional commit's hash when changelog files updated.
  */
 async function updatePackages(
 	gitWorkingDirectoryPath,
@@ -251,8 +253,14 @@ async function updatePackages(
 		true,
 		abortMessage
 	);
-	git.commit( gitWorkingDirectoryPath, 'Update changelog files', [ './*' ] );
+	const commitHash = await git.commit(
+		gitWorkingDirectoryPath,
+		'Update changelog files',
+		[ './*' ]
+	);
 	log( '>> Changelog files changes have been committed successfully.' );
+
+	return commitHash;
 }
 
 /**
@@ -283,6 +291,8 @@ async function runPushGitChangesStep(
  * @param {string}      gitWorkingDirectoryPath Git working directory path.
  * @param {SemVer}      minimumVersionBump      Minimum version bump for the packages.
  * @param {ReleaseType} releaseType             Release type selected from CLI.
+ *
+ * @return {?string}   The optional commit's hash when changelog files updated.
  */
 async function publishPackagesToNpm(
 	gitWorkingDirectoryPath,
@@ -298,9 +308,11 @@ async function publishPackagesToNpm(
 		log(
 			'>> Bumping version of public packages changed since the last release.'
 		);
-		const { stdout: sha } = await command( 'git rev-parse --short HEAD' );
+		const commitHash = await git.getLastCommitHash(
+			gitWorkingDirectoryPath
+		);
 		await command(
-			`npx lerna version pre${ minimumVersionBump } --preid next.${ sha } --no-private`,
+			`npx lerna version pre${ minimumVersionBump } --preid next.${ commitHash } --no-private`,
 			{
 				cwd: gitWorkingDirectoryPath,
 				stdio: 'inherit',
@@ -336,6 +348,39 @@ async function publishPackagesToNpm(
 			stdio: 'inherit',
 		} );
 	}
+
+	return await git.getLastCommitHash( gitWorkingDirectoryPath );
+}
+
+/**
+ * Backports commits from the release branch to the `trunk` branch.
+ *
+ * @param {string}      gitWorkingDirectoryPath Git working directory path.
+ * @param {ReleaseType} releaseType             Release type selected from CLI.
+ * @param {string[]}    commits                 The list of commits to backport.
+ *
+ */
+async function backportCommitsToTrunk(
+	gitWorkingDirectoryPath,
+	releaseType,
+	commits
+) {
+	if (
+		! [ 'latest', 'bugfix' ].includes( releaseType ) ||
+		commits.length === 0
+	) {
+		return;
+	}
+
+	log( '>> Backporting commits.' );
+	await git.resetLocalBranchAgainstOrigin( gitWorkingDirectoryPath, 'trunk' );
+	for ( const commitHash of commits ) {
+		await git.cherrypickCommitIntoBranch(
+			gitWorkingDirectoryPath,
+			commitHash
+		);
+	}
+	await git.pushBranchToOrigin( gitWorkingDirectoryPath, 'trunk' );
 }
 
 /**
@@ -369,7 +414,7 @@ async function prepareForPackageRelease(
 		abortMessage
 	);
 
-	await updatePackages(
+	const commitHashChangelogUpdates = await updatePackages(
 		gitWorkingDirectoryPath,
 		minimumVersionBump,
 		releaseType,
@@ -382,12 +427,18 @@ async function prepareForPackageRelease(
 		`Aborting! Make sure to push changes applied to WordPress release branch "${ releaseBranch }" manually.`
 	);
 
-	await publishPackagesToNpm(
+	const commitHashNpmPublish = await publishPackagesToNpm(
 		gitWorkingDirectoryPath,
 		minimumVersionBump,
 		releaseType
 	);
 
+	await backportCommitsToTrunk(
+		gitWorkingDirectoryPath,
+		releaseType,
+		[ commitHashChangelogUpdates, commitHashNpmPublish ].filter( Boolean )
+	);
+
 	await runCleanLocalFoldersStep( temporaryFolders, 'Cleaning failed.' );
 }
 
@@ -417,10 +468,7 @@ async function publishNpmLatestDistTag() {
 
 	log(
 		'\n>> 🎉 WordPress packages are now published!\n\n',
-		'Please remember to run `git cherry-pick` in the `trunk` branch for the newly created commits during the release with labels:\n',
-		' - Update changelog files (if exists)\n',
-		' - chore(release): publish\n\n',
-		'Finally, let also people know on WordPress Slack and celebrate together.'
+		'Let also people know on WordPress Slack and celebrate together.'
 	);
 }
 
@@ -439,15 +487,12 @@ async function publishNpmBugfixLatestDistTag() {
 	await prepareForPackageRelease(
 		'bugfix',
 		'patch',
-		'Before we proceed, can you confirm that all required changes have beed already cherry-picked to the release branch?'
+		'Before we proceed, can you confirm that all required changes have been already cherry-picked to the release branch?'
 	);
 
 	log(
 		'\n>> 🎉 WordPress packages are now published!\n\n',
-		'Please remember to run `git cherry-pick` in the `trunk` branch for the newly created commits during the release with labels:\n',
-		' - Update changelog files (if exists)\n',
-		' - chore(release): publish\n\n',
-		'Finally, let also people know on WordPress Slack and celebrate together.'
+		'Let also people know on WordPress Slack and celebrate together.'
 	);
 }