tools/release/lib/milestone.js - trunk - githubmirror/gutenberg

tools/release/lib/milestone.js
111 строк3 KB
Tushar Bharti
Tools(Release): migrate bin/plugin into @wordpress/release-tools workspace (#77695)
18 май 2026, 15:45
18 май 2026, 15:458e7a3a1
/** @typedef {import('@octokit/rest')} GitHub */
/** @typedef {import('@octokit/rest').IssuesListForRepoResponseItem} IssuesListForRepoResponseItem */
/** @typedef {import('@octokit/rest').IssuesListMilestonesForRepoResponseItem} OktokitIssuesListMilestonesForRepoResponseItem */

/**
 * @typedef {"open"|"closed"|"all"} IssueState
 */

/**
 * 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.
 * @param {IssueState} [state]       Optional issue state.
 * @param {string}     [closedSince] Optional timestamp.
 *
 * @return {Promise<IssuesListForRepoResponseItem[]>} Promise resolving to pull
 *                                                    requests for the given
 *                                                    milestone.
 */
async function getIssuesByMilestone(
	octokit,
	owner,
	repo,
	milestone,
	state,
	closedSince
) {
	const options = octokit.issues.listForRepo.endpoint.merge( {
		owner,
		repo,
		milestone,
		state,
		...( closedSince && {
			since: closedSince,
		} ),
	} );

	/**
	 * @type {AsyncIterableIterator<import('@octokit/rest').Response<import('@octokit/rest').IssuesListForRepoResponse>>}
	 */
	const responses = octokit.paginate.iterator( options );

	/**
	 * @type {import('@octokit/rest').IssuesListForRepoResponse}
	 */
	const pulls = [];

	for await ( const response of responses ) {
		const issues = response.data;
		pulls.push( ...issues );
	}

	if ( closedSince ) {
		const closedSinceTimestamp = new Date( closedSince );

		return pulls.filter(
			( pull ) =>
				pull.closed_at &&
				closedSinceTimestamp <
					new Date(
						// The ugly `as unknown as string` cast is required because of
						// https://github.com/octokit/plugin-rest-endpoint-methods.js/issues/64
						// Fixed in Octokit v18.1.1, see https://github.com/WordPress/gutenberg/pull/29043
						/** @type {string} */ (
							/** @type {unknown} */ ( pull.closed_at )
						)
					)
		);
	}

	return pulls;
}

module.exports = {
	getMilestoneByTitle,
	getIssuesByMilestone,
};