tools/release/commands/common.js - trunk - githubmirror/gutenberg

tools/release/commands/common.js
108 строк3 KB
Marco Ciampini
ESLint: Replace strict config with bulk suppressions (#81248)
07 авг 2026, 14:34
07 авг 2026, 14:347f43eaf
const semver = require( 'semver' );
const SimpleGit = require( 'simple-git' );
const { readJSONFile } = require( '../lib/utils' );

/**
 * Finds the name of the current plugin release branch based on the version in
 * the package.json file and the latest `trunk` branch in `git`.
 *
 * @param {string} gitWorkingDirectoryPath Path to the project's working directory.
 *
 * @return {string} Name of the plugin release branch.
 */
async function findPluginReleaseBranchName( gitWorkingDirectoryPath ) {
	await SimpleGit( gitWorkingDirectoryPath )
		.fetch( 'origin', 'trunk' )
		.checkout( 'trunk' );

	const packageJsonPath = gitWorkingDirectoryPath + '/package.json';
	const mainPackageJson = readJSONFile( packageJsonPath );
	const mainParsedVersion = semver.parse( mainPackageJson.version );

	return 'release/' + mainParsedVersion.major + '.' + mainParsedVersion.minor;
}

/**
 * Calculates version bump for the packages based on the content
 * from the provided CHANGELOG file split into individual lines.
 *
 * @param {string[]}                  lines                Changelog content split into lines.
 * @param {('patch'|'minor'|'major')} [minimumVersionBump] Minimum version bump for the package.
 *                                                         Defaults to `patch`.
 * @param {string}                    [currentVersion]     Current version of the package.
 *
 * @return {string|null} Version bump when applicable, or null otherwise.
 */
function calculateVersionBumpFromChangelog(
	lines,
	minimumVersionBump = 'patch',
	currentVersion = '1.0.0'
) {
	let changesDetected = false;
	let versionBump = null;
	for ( const line of lines ) {
		const lineNormalized = line.toLowerCase().trimStart();
		// Detect unpublished changes first.
		if ( lineNormalized.startsWith( '## unreleased' ) ) {
			changesDetected = true;
			continue;
		}

		// Skip all lines until unpublished changes found.
		if ( ! changesDetected ) {
			continue;
		}

		// A previous published version detected. Stop processing.
		if ( lineNormalized.startsWith( '## ' ) ) {
			break;
		}

		// Promote a pre-1.0 package to stable 1.0.0 release. Stop processing.
		if (
			lineNormalized.startsWith( '### stable release' ) &&
			semver.lt( currentVersion, '1.0.0' )
		) {
			versionBump = 'major';
			break;
		}

		// A major version bump required for stable packages. Stop processing.
		if ( lineNormalized.startsWith( '### breaking change' ) ) {
			if ( semver.lt( currentVersion, '1.0.0' ) ) {
				versionBump = 'minor';
			} else {
				versionBump = 'major';
			}

			break;
		}

		// A minor version bump required. Proceed to the next line.
		if (
			lineNormalized.startsWith( '### deprecation' ) ||
			lineNormalized.startsWith( '### enhancement' ) ||
			lineNormalized.startsWith( '### new api' ) ||
			lineNormalized.startsWith( '### new feature' )
		) {
			versionBump = 'minor';
			continue;
		}

		// A version bump required. Found new changelog section.
		if (
			versionBump !== 'minor' &&
			( lineNormalized.startsWith( '### ' ) ||
				lineNormalized.includes( '- ' ) )
		) {
			versionBump = minimumVersionBump;
		}
	}

	return versionBump;
}

module.exports = {
	calculateVersionBumpFromChangelog,
	findPluginReleaseBranchName,
};