-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge changes published in the Gutenberg plugin "release/8.1" branch
- Loading branch information
Showing
486 changed files
with
9,390 additions
and
3,229 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,271 @@ | ||
| #!/usr/bin/env node | ||
| 'use strict'; | ||
|
|
||
| /* | ||
| * External dependencies | ||
| */ | ||
| const { groupBy } = require( 'lodash' ); | ||
| const chalk = require( 'chalk' ); | ||
| const Octokit = require( '@octokit/rest' ); | ||
|
|
||
| /* | ||
| * Internal dependencies | ||
| */ | ||
| // @ts-ignore | ||
| const manifest = require( '../package.json' ); | ||
|
|
||
| /** @typedef {import('@octokit/rest')} GitHub */ | ||
| /** @typedef {import('@octokit/rest').IssuesListForRepoResponseItem} IssuesListForRepoResponseItem */ | ||
| /** @typedef {import('@octokit/rest').IssuesListMilestonesForRepoResponseItem} OktokitIssuesListMilestonesForRepoResponseItem */ | ||
|
|
||
| /** | ||
| * @typedef WPChangelogSettings | ||
| * | ||
| * @property {string} owner Repository owner. | ||
| * @property {string} repo Repository name. | ||
| * @property {string=} token Optional personal access token. | ||
| * @property {string} milestone Milestone title. | ||
| */ | ||
|
|
||
| /** | ||
| * Optional GitHub token used to authenticate requests. | ||
| * | ||
| * @type {string=} | ||
| */ | ||
| const GITHUB_TOKEN = process.env.GITHUB_TOKEN; | ||
|
|
||
| /** | ||
| * Optional explicit milestone title to use for generating changelog. | ||
| * | ||
| * @type {string=} | ||
| */ | ||
| const MILESTONE = process.env.MILESTONE; | ||
|
|
||
| /** | ||
| * 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 a type label for a given issue object, or a default if type cannot | ||
| * be determined. | ||
| * | ||
| * @param {IssuesListForRepoResponseItem} issue Issue object. | ||
| * | ||
| * @return {string} Type label. | ||
| */ | ||
| function getIssueType( issue ) { | ||
| const typeLabel = issue.labels.find( ( label ) => | ||
| label.name.startsWith( '[Type] ' ) | ||
| ); | ||
|
|
||
| return typeLabel ? typeLabel.name.replace( /^\[Type\] /, '' ) : 'Various'; | ||
| } | ||
|
|
||
| /** | ||
| * Given an issue title, returns the title with normalization transforms | ||
| * applied. | ||
| * | ||
| * @param {string} title Original title. | ||
| * | ||
| * @return {string} Normalized title. | ||
| */ | ||
| function getNormalizedTitle( title ) { | ||
| if ( ! title.endsWith( '.' ) ) { | ||
| title = title + '.'; | ||
| } | ||
|
|
||
| return title; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a formatted changelog entry for a given issue object. | ||
| * | ||
| * @param {IssuesListForRepoResponseItem} issue Issue object. | ||
| * | ||
| * @return {string} Formatted changelog entry. | ||
| */ | ||
| function getEntry( issue ) { | ||
| const title = getNormalizedTitle( issue.title ); | ||
|
|
||
| return `- ${ 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. | ||
| * | ||
| * @param {GitHub} octokit GitHub REST client. | ||
| * @param {WPChangelogSettings} settings Changelog settings. | ||
| * | ||
| * @return {Promise<IssuesListForRepoResponseItem[]>} Promise resolving to array of | ||
| * pull requests. | ||
| */ | ||
| async function fetchAllPullRequests( octokit, settings ) { | ||
| const { owner, repo, milestone: milestoneTitle } = settings; | ||
| const milestone = await getMilestoneByTitle( | ||
| octokit, | ||
| owner, | ||
| repo, | ||
| milestoneTitle | ||
| ); | ||
|
|
||
| if ( ! milestone ) { | ||
| throw new Error( | ||
| `Cannot find milestone by title: ${ settings.milestone }` | ||
| ); | ||
| } | ||
|
|
||
| const { number } = milestone; | ||
| return getPullRequestsByMilestone( octokit, owner, repo, number ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a promise resolving to the changelog string for given settings. | ||
| * | ||
| * @param {WPChangelogSettings} settings Changelog settings. | ||
| * | ||
| * @return {Promise<string>} Promise resolving to changelog. | ||
| */ | ||
| async function getChangelog( settings ) { | ||
| const octokit = new Octokit( { | ||
| auth: settings.token, | ||
| } ); | ||
|
|
||
| const pullRequests = await fetchAllPullRequests( octokit, settings ); | ||
| if ( ! pullRequests.length ) { | ||
| throw new Error( | ||
| 'There are no pull requests associated with the milestone.' | ||
| ); | ||
| } | ||
|
|
||
| let changelog = ''; | ||
|
|
||
| const groupedPullRequests = groupBy( pullRequests, getIssueType ); | ||
| for ( const group of Object.keys( groupedPullRequests ) ) { | ||
| changelog += '### ' + group + '\n\n'; | ||
|
|
||
| const groupPullRequests = groupedPullRequests[ group ]; | ||
| for ( const pullRequest of groupPullRequests ) { | ||
| changelog += getEntry( pullRequest ) + '\n'; | ||
| } | ||
|
|
||
| changelog += '\n'; | ||
| } | ||
|
|
||
| return changelog; | ||
| } | ||
|
|
||
| /** | ||
| * Generates and logs changelog for a milestone. | ||
| * | ||
| * @param {WPChangelogSettings} settings Changelog settings. | ||
| */ | ||
| async function createChangelog( settings ) { | ||
| console.log( | ||
| chalk.bold( | ||
| `💃Preparing changelog for milestone: "${ settings.milestone }"\n\n` | ||
| ) | ||
| ); | ||
|
|
||
| let changelog; | ||
| try { | ||
| changelog = await getChangelog( settings ); | ||
| } catch ( error ) { | ||
| changelog = chalk.yellow( error.stack ); | ||
| } | ||
|
|
||
| console.log( changelog ); | ||
| } | ||
|
|
||
| if ( ! module.parent ) { | ||
| createChangelog( { | ||
| owner: 'WordPress', | ||
| repo: 'gutenberg', | ||
| token: GITHUB_TOKEN, | ||
| milestone: | ||
| MILESTONE === undefined | ||
| ? getMilestone( manifest.version ) | ||
| : MILESTONE, | ||
| } ); | ||
| } | ||
|
|
||
| /** @type {NodeJS.Module} */ ( module ).exports = { | ||
| getNormalizedTitle, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.