Template 04 Controls ESNext

.eslintrc.js

@@ -121,6 +121,10 @@ module.exports = {
 					'Avoid truthy checks on length property rendering, as zero length is rendered verbatim.',
 			},
 		],
+		// Temporarily converted to warning until all errors are resolved.
+		// See https://github.com/WordPress/gutenberg/pull/22771 for the eslint-plugin-jsdoc update.
+		'jsdoc/check-param-names': 'warn',
+		'jsdoc/require-param': 'warn',
 	},
 	overrides: [
 		{

.github/CODEOWNERS

@@ -8,21 +8,21 @@
 /packages/core-data                             @youknowriad @nerrad
 /packages/data                                  @youknowriad @nerrad @coderkevin
 /packages/redux-routine                         @youknowriad @nerrad
-/packages/data-controls                         @nerrad @aduth
+/packages/data-controls                         @nerrad
 
 # Blocks
-/packages/block-library                         @Soean @ajitbohra @jorgefilipecosta @talldan
+/packages/block-library                         @Soean @ajitbohra @talldan
 /packages/block-library/src/gallery             @mkevins @pinarol
 /packages/block-library/src/social-links        @mkaz
 /packages/block-library/src/social-link         @mkaz
 
 # Editor
 /packages/annotations                           @atimmer @ellatrix
-/packages/autop                                 @aduth
+/packages/autop
 /packages/block-editor                          @youknowriad @ellatrix
 /packages/block-serialization-spec-parser       @dmsnell
 /packages/block-serialization-default-parser    @dmsnell
-/packages/blocks                                @youknowriad @ellatrix @aduth
+/packages/blocks                                @youknowriad @ellatrix
 /packages/edit-post
 /packages/editor
 /packages/list-reusable-blocks                  @youknowriad
@@ -63,35 +63,35 @@
 /packages/postcss-themes                        @youknowriad @ntwb @nerrad @ajitbohra
 /packages/scripts                               @gziolo @ntwb @nerrad @ajitbohra
 /packages/dependency-extraction-webpack-plugin  @gziolo
-/packages/prettier-config                       @ntwb @gziolo @aduth
+/packages/prettier-config                       @ntwb @gziolo
 
 # UI Components
-/packages/components                            @youknowriad @ajitbohra @jaymanpandya @jorgefilipecosta @chrisvanpatten
-/packages/compose                               @youknowriad @ajitbohra @jaymanpandya @jorgefilipecosta
-/packages/element                               @youknowriad @ajitbohra @jaymanpandya @jorgefilipecosta
-/packages/notices                               @ajitbohra @jaymanpandya @jorgefilipecosta
-/packages/nux                                   @ajitbohra @jaymanpandya @jorgefilipecosta
-/packages/viewport                              @ajitbohra @jaymanpandya @jorgefilipecosta
+/packages/components                            @youknowriad @ajitbohra @jaymanpandya @chrisvanpatten
+/packages/compose                               @youknowriad @ajitbohra @jaymanpandya
+/packages/element                               @youknowriad @ajitbohra @jaymanpandya
+/packages/notices                               @ajitbohra @jaymanpandya
+/packages/nux                                   @ajitbohra @jaymanpandya
+/packages/viewport                              @ajitbohra @jaymanpandya
 /packages/base-styles
 /packages/icons
 /packages/primitives
 
 # Utilities
-/packages/a11y                                  @youknowriad @aduth
-/packages/blob                                  @aduth
+/packages/a11y                                  @youknowriad
+/packages/blob
 /packages/date
-/packages/deprecated                            @youknowriad @aduth
+/packages/deprecated                            @youknowriad
 /packages/dom                                   @ellatrix
-/packages/dom-ready                             @aduth
+/packages/dom-ready
 /packages/escape-html
 /packages/html-entities
 /packages/i18n                                  @swissspidy
-/packages/is-shallow-equal                      @aduth
+/packages/is-shallow-equal
 /packages/keycodes                              @talldan @ellatrix
-/packages/priority-queue                        @youknowriad @aduth
-/packages/token-list                            @aduth
-/packages/url                                   @talldan @aduth
-/packages/wordcount                             @aduth
+/packages/priority-queue                        @youknowriad
+/packages/token-list
+/packages/url                                   @talldan
+/packages/wordcount
 /packages/warning
 /packages/keyboard-shortcuts
 
@@ -100,13 +100,13 @@
 /packages/plugins                               @gziolo @adamsilverstein
 
 # Rich Text
-/packages/format-library                        @ellatrix @jorgefilipecosta @daniloercoli @sergioestevao @etoledom
-/packages/rich-text                             @ellatrix @jorgefilipecosta @daniloercoli @sergioestevao @etoledom
-/packages/block-editor/src/components/rich-text @ellatrix @jorgefilipecosta @daniloercoli @sergioestevao @etoledom
+/packages/format-library                        @ellatrix @daniloercoli @sergioestevao @etoledom
+/packages/rich-text                             @ellatrix @daniloercoli @sergioestevao @etoledom
+/packages/block-editor/src/components/rich-text @ellatrix @daniloercoli @sergioestevao @etoledom
 
 # Project Management
 /.github                                        @youknowriad @mapk @karmatosed
-/packages/project-management-automation         @aduth
+/packages/project-management-automation
 
 # wp-env
 /packages/env                                   @epiqueras @noahtallen

.travis.yml

@@ -53,7 +53,8 @@ install:
   - npm run build
   - |
     if [[ "$INSTALL_WORDPRESS" = "true" ]]; then
-      echo '{ "config": { "SCRIPT_DEBUG": false, "WP_PHP_BINARY": "php" } }' > .wp-env.override.json
+      echo '{ "config": { "SCRIPT_DEBUG": false, "WP_PHP_BINARY": "php", "WP_TESTS_EMAIL": "[email protected]", "WP_TESTS_TITLE": "Test Blog" } }' > .wp-env.override.json
+      chmod -R 767 ./ # TODO: Possibly integrate in wp-env
       npm run wp-env start
     fi
   - |
@@ -128,15 +129,12 @@ jobs:
         - npm run test-unit:native -- --ci --maxWorkers=2 --cacheDirectory="$HOME/.jest-cache"
 
     - name: PHP unit tests
-      env: WP_ENV_TESTS_PORT=8887 WP_ENV_PORT=8886 # TODO: Remove tests port when scripts/env is replaced with wp-env.
       script:
-        - chmod -R 767 ./build
         - npm run test-php && npm run test-unit-php-multisite
 
     - name: PHP unit tests (PHP 5.6)
-      env: LOCAL_PHP=5.6-fpm WP_ENV_TESTS_PORT=8887 WP_ENV_PORT=8886 # TODO: Remove tests port when scripts/env is replaced with wp-env.
+      env: LOCAL_PHP=5.6-fpm
       script:
-        - chmod -R 767 ./build
         - npm run test-php && npm run test-unit-php-multisite
 
     - name: E2E tests (Admin) (1/4)

bin/plugin/commands/changelog.js

@@ -3,11 +3,17 @@
  */
 const { groupBy, escapeRegExp, uniq } = require( 'lodash' );
 const Octokit = require( '@octokit/rest' );
+const { sprintf } = require( 'sprintf-js' );
+const semver = require( 'semver' );
 
 /**
  * Internal dependencies
  */
 const { getNextMajorVersion } = require( '../lib/version' );
+const {
+	getMilestoneByTitle,
+	getIssuesByMilestone,
+} = require( '../lib/milestone' );
 const { log, formats } = require( '../lib/logger' );
 const config = require( '../config' );
 // @ts-ignore
@@ -98,22 +104,6 @@ const REWORD_TERMS = {
 	docs: 'documentation',
 };
 
-/**
- * Given a SemVer-formatted version string, returns an assumed milestone title
- * associated with that version.
- *
- * @see https://semver.org/
- *
- * @param {string} version Version string.
- *
- * @return {string} Milestone title.
- */
-function getMilestone( version ) {
-	const [ major, minor ] = version.split( '.' );
-
-	return `Gutenberg ${ major }.${ minor }`;
-}
-
 /**
  * Returns type candidates based on given issue label names.
  *
@@ -346,72 +336,6 @@ function getEntry( issue ) {
 		: `- ${ title } ([${ issue.number }](${ issue.html_url }))`;
 }
 
-/**
- * Returns a promise resolving to a milestone by a given title, if exists.
- *
- * @param {GitHub} octokit Initialized Octokit REST client.
- * @param {string} owner   Repository owner.
- * @param {string} repo    Repository name.
- * @param {string} title   Milestone title.
- *
- * @return {Promise<OktokitIssuesListMilestonesForRepoResponseItem|void>} Promise resolving to milestone, if exists.
- */
-async function getMilestoneByTitle( octokit, owner, repo, title ) {
-	const options = octokit.issues.listMilestonesForRepo.endpoint.merge( {
-		owner,
-		repo,
-	} );
-
-	/**
-	 * @type {AsyncIterableIterator<import('@octokit/rest').Response<import('@octokit/rest').IssuesListMilestonesForRepoResponse>>}
-	 */
-	const responses = octokit.paginate.iterator( options );
-
-	for await ( const response of responses ) {
-		const milestones = response.data;
-		for ( const milestone of milestones ) {
-			if ( milestone.title === title ) {
-				return milestone;
-			}
-		}
-	}
-}
-
-/**
- * Returns a promise resolving to pull requests by a given milestone ID.
- *
- * @param {GitHub} octokit   Initialized Octokit REST client.
- * @param {string} owner     Repository owner.
- * @param {string} repo      Repository name.
- * @param {number} milestone Milestone ID.
- *
- * @return {Promise<IssuesListForRepoResponseItem[]>} Promise resolving to pull
- *                                                    requests for the given
- *                                                    milestone.
- */
-async function getPullRequestsByMilestone( octokit, owner, repo, milestone ) {
-	const options = octokit.issues.listForRepo.endpoint.merge( {
-		owner,
-		repo,
-		milestone,
-		state: 'closed',
-	} );
-
-	/**
-	 * @type {AsyncIterableIterator<import('@octokit/rest').Response<import('@octokit/rest').IssuesListForRepoResponse>>}
-	 */
-	const responses = octokit.paginate.iterator( options );
-
-	const pulls = [];
-
-	for await ( const response of responses ) {
-		const issues = response.data;
-		pulls.push( ...issues.filter( ( issue ) => issue.pull_request ) );
-	}
-
-	return pulls;
-}
-
 /**
  * Returns a promise resolving to an array of pull requests associated with the
  * changelog settings object.
@@ -438,7 +362,14 @@ async function fetchAllPullRequests( octokit, settings ) {
 	}
 
 	const { number } = milestone;
-	return getPullRequestsByMilestone( octokit, owner, repo, number );
+	const issues = await getIssuesByMilestone(
+		octokit,
+		owner,
+		repo,
+		number,
+		'closed'
+	);
+	return issues.filter( ( issue ) => issue.pull_request );
 }
 
 /**
@@ -516,7 +447,16 @@ async function getReleaseChangelog( options ) {
 		token: options.token,
 		milestone:
 			options.milestone === undefined
-				? getMilestone( getNextMajorVersion( manifest.version ) )
+				? // Disable reason: valid-sprintf applies to `@wordpress/i18n` where
+				  // strings are expected to need to be extracted, and thus variables are
+				  // not allowed. This string will not need to be extracted.
+				  // eslint-disable-next-line @wordpress/valid-sprintf
+				  sprintf( config.versionMilestoneFormat, {
+						...config,
+						...semver.parse(
+							getNextMajorVersion( manifest.version )
+						),
+				  } )
 				: options.milestone,
 	} );
 }

bin/plugin/commands/release.js

@@ -5,6 +5,7 @@ const inquirer = require( 'inquirer' );
 const fs = require( 'fs' );
 const semver = require( 'semver' );
 const Octokit = require( '@octokit/rest' );
+const { sprintf } = require( 'sprintf-js' );
 
 /**
  * Internal dependencies
@@ -19,6 +20,10 @@ const {
 const git = require( '../lib/git' );
 const svn = require( '../lib/svn' );
 const { getNextMajorVersion } = require( '../lib/version' );
+const {
+	getIssuesByMilestone,
+	getMilestoneByTitle,
+} = require( '../lib/milestone' );
 const config = require( '../config' );
 const {
 	runGitRepositoryCloneStep,
@@ -624,6 +629,50 @@ async function updateThePluginStableVersion(
 	);
 }
 
+/**
+ * Checks whether the milestone associated with the release has open issues or
+ * pull requests. Returns a promise resolving to true if there are no open issue
+ * or pull requests, or false otherwise.
+ *
+ * @param {string} version Release version.
+ *
+ * @return {Promise<boolean>} Promise resolving to boolean indicating whether
+ *                            the milestone is clear of open issues.
+ */
+async function isMilestoneClear( version ) {
+	const { githubRepositoryOwner: owner, githubRepositoryName: name } = config;
+	const octokit = new Octokit();
+	const milestone = await getMilestoneByTitle(
+		octokit,
+		owner,
+		name,
+		// Disable reason: valid-sprintf applies to `@wordpress/i18n` where
+		// strings are expected to need to be extracted, and thus variables are
+		// not allowed. This string will not need to be extracted.
+		// eslint-disable-next-line @wordpress/valid-sprintf
+		sprintf( config.versionMilestoneFormat, {
+			...config,
+			...semver.parse( version ),
+		} )
+	);
+
+	if ( ! milestone ) {
+		// If milestone can't be found, it's not especially actionable to warn
+		// that the milestone isn't clear. `true` is the sensible fallback.
+		return true;
+	}
+
+	const issues = await getIssuesByMilestone(
+		new Octokit(),
+		owner,
+		name,
+		milestone.number,
+		'open'
+	);
+
+	return issues.length === 0;
+}
+
 /**
  * Release a new version.
  *
@@ -661,6 +710,14 @@ async function releasePlugin( isRC = true ) {
 				abortMessage
 		  );
 
+	if ( ! ( await isMilestoneClear( version ) ) ) {
+		await askForConfirmation(
+			'There are still open issues in the milestone. Are you sure you want to proceed?',
+			false,
+			abortMessage
+		);
+	}
+
 	// Bumping the version and commit.
 	const commitHash = await runBumpPluginVersionUpdateChangelogAndCommitStep(
 		gitWorkingDirectory,

bin/plugin/config.js

@@ -6,6 +6,10 @@ const gitRepoOwner = 'WordPress';
  * @property {string} slug Slug.
  * @property {string} name Name.
  * @property {string} team Github Team Name.
+ * @property {string} versionMilestoneFormat printf template for milestone
+ *                                           version name. Expected to be called
+ *                                           with a merged object of the config
+ *                                           and semver-parsed version parts.
  * @property {string} githubRepositoryOwner Github Repository Owner.
  * @property {string} githubRepositoryName Github Repository Name.
  * @property {string} pluginEntryPoint Plugin Entry Point File.
@@ -22,6 +26,7 @@ const config = {
 	slug: 'gutenberg',
 	name: 'Gutenberg',
 	team: 'Gutenberg Core',
+	versionMilestoneFormat: '%(name)s %(major)s.%(minor)s',
 	githubRepositoryOwner: gitRepoOwner,
 	githubRepositoryName: 'gutenberg',
 	pluginEntryPoint: 'gutenberg.php',