@ckeditor/ckeditor5-dev-release-tools 38.1.4 → 38.2.0

package/lib/index.js

@@ -20,6 +20,7 @@ const { getLastFromChangelog, getLastNightly, getNextNightly, getCurrent, getLas
 const { getChangesForVersion, getChangelog, saveChangelog } = require( './utils/changelog' );
 const executeInParallel = require( './utils/executeinparallel' );
 const validateRepositoryToRelease = require( './utils/validaterepositorytorelease' );
+const checkVersionAvailability = require( './utils/checkversionavailability' );
 
 module.exports = {
 	generateChangelogForSinglePackage,
@@ -42,5 +43,6 @@ module.exports = {
 	getChangesForVersion,
 	getChangelog,
 	saveChangelog,
-	validateRepositoryToRelease
+	validateRepositoryToRelease,
+	checkVersionAvailability
 };

package/lib/tasks/generatechangelogformonorepository.js

@@ -54,12 +54,17 @@ const noteInfo = `[ℹ️](${ VERSIONING_POLICY_URL }#major-and-minor-breaking-c
  * @param {Array.<ExternalRepository>} [options.externalRepositories=[]] An array of object with additional repositories
  * that the function takes into consideration while gathering commits. It assumes that those directories are also mono repositories.
  *
- * @returns {Promise}
+ * @param {Boolean} [options.skipFileSave=false] Whether to resolve the changes instead of saving it to a file.
+ *
+ * @param {String|null} [options.nextVersion=null] Next version to use. If not provided, a user needs to provide via CLI.
+ *
+ * @returns {Promise.<undefined|String>}
  */
 module.exports = async function generateChangelogForMonoRepository( options ) {
 	const log = logger();
 	const cwd = process.cwd();
-	const pkgJson = getPackageJson( options.cwd );
+	const rootPkgJson = getPackageJson( options.cwd );
+	const skipFileSave = options.skipFileSave || false;
 
 	logProcess( 'Collecting paths to packages...' );
 
@@ -71,16 +76,23 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 		externalRepositories: options.externalRepositories || []
 	} );
 
+	const commitOptions = {
+		cwd: options.cwd,
+		from: options.from ? options.from : 'v' + rootPkgJson.version,
+		releaseBranch: options.releaseBranch || 'master',
+		externalRepositories: options.externalRepositories || []
+	};
+
 	logProcess( 'Collecting all commits since the last release...' );
 
 	// Collection of all entries (real commits + additional "fake" commits extracted from descriptions).
-	let allCommits;
+	const allCommits = await gatherAllCommits( commitOptions );
 
 	// Collection of public entries that will be inserted in the changelog.
 	let publicCommits;
 
-	// The next version for the upcoming release.
-	let nextVersion = null;
+	// The next version for the upcoming release. If not specified, a user has to provide via CLI.
+	let nextVersion = options.nextVersion || null;
 
 	// A map contains packages and their new versions.
 	const packagesVersion = new Map();
@@ -91,44 +103,52 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 	// A map contains packages and their paths (where they are located)
 	const packagesPaths = new Map();
 
-	const commitOptions = {
-		cwd: options.cwd,
-		from: options.from ? options.from : 'v' + pkgJson.version,
-		releaseBranch: options.releaseBranch || 'master',
-		externalRepositories: options.externalRepositories || []
-	};
+	logInfo( `Found ${ allCommits.length } entries to parse.`, { indentLevel: 1, startWithNewLine: true } );
 
-	return gatherAllCommits( commitOptions )
-		.then( commits => {
-			allCommits = commits;
+	// If the next version is specified by the integrator, setup internal values used when preparing
+	// the "Releases packages" section.
+	if ( nextVersion ) {
+		packagesVersion.set( rootPkgJson.name, nextVersion );
 
-			logInfo( `Found ${ commits.length } entries to parse.`, { indentLevel: 1, startWithNewLine: true } );
-		} )
-		.then( () => typeNewVersionForAllPackages() )
-		.then( () => generateChangelogFromCommits() )
-		.then( changesFromCommits => saveChangelog( changesFromCommits ) )
-		.then( () => {
-			logProcess( 'Summary' );
+		for ( const packagePath of pathsCollection.matched ) {
+			const packageJson = getPackageJson( packagePath );
 
-			displaySkippedPackages( new Set( [
-				...pathsCollection.skipped
-			].sort() ) );
+			currentPackagesVersion.set( packageJson.name, packageJson.version );
+			packagesPaths.set( packageJson.name, packagePath );
+			packagesVersion.set( packageJson.name, nextVersion );
+		}
+	} else {
+		await typeNewVersionForAllPackages();
+	}
 
-			// Make a commit from the repository where we started.
-			process.chdir( options.cwd );
-			tools.shExec( `git add ${ changelogUtils.changelogFile }`, { verbosity: 'error' } );
-			tools.shExec( 'git commit -m "Docs: Changelog. [skip ci]"', { verbosity: 'error' } );
-
-			logInfo(
-				`Changelog for "${ chalk.underline( pkgJson.name ) }" (v${ packagesVersion.get( pkgJson.name ) }) has been generated.`,
-				{ indentLevel: 1 }
-			);
-
-			process.chdir( cwd );
-		} )
-		.catch( err => {
-			console.log( err );
-		} );
+	if ( !skipFileSave ) {
+		await saveChangelog();
+
+		// Make a commit from the repository where we started.
+		process.chdir( options.cwd );
+		tools.shExec( `git add ${ changelogUtils.changelogFile }`, { verbosity: 'error' } );
+		tools.shExec( 'git commit -m "Docs: Changelog. [skip ci]"', { verbosity: 'error' } );
+		logInfo( 'Committed.', { indentLevel: 1 } );
+	}
+
+	process.chdir( cwd );
+
+	logProcess( 'Summary' );
+
+	displaySkippedPackages( new Set( [
+		...pathsCollection.skipped
+	].sort() ) );
+
+	logInfo(
+		`Changelog for "${ chalk.underline( rootPkgJson.name ) }" (v${ packagesVersion.get( rootPkgJson.name ) }) has been generated.`,
+		{ indentLevel: 1 }
+	);
+
+	if ( skipFileSave ) {
+		return getChangelogForNextVersion();
+	}
+
+	return Promise.resolve();
 
 	/**
 	 * Returns collections with packages found in the `options.cwd` directory and the external repositories.
@@ -191,6 +211,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 	 * @returns {Promise.<Array.<Commit>>}
 	 */
 	function gatherAllCommits( options ) {
+		process.chdir( options.cwd );
 		logInfo( `Processing "${ options.cwd }"...`, { indentLevel: 1 } );
 
 		const transformCommit = transformCommitFactory( {
@@ -375,15 +396,15 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 	function generateChangelogFromCommits() {
 		logProcess( 'Generating the changelog...' );
 
-		const version = packagesVersion.get( pkgJson.name );
+		const version = packagesVersion.get( rootPkgJson.name );
 
 		const writerContext = {
 			version,
 			commit: 'commit',
 			repoUrl: getRepositoryUrl( options.cwd ),
 			currentTag: 'v' + version,
-			previousTag: options.from ? options.from : 'v' + pkgJson.version,
-			isPatch: semver.diff( version, pkgJson.version ) === 'patch',
+			previousTag: options.from ? options.from : 'v' + rootPkgJson.version,
+			isPatch: semver.diff( version, rootPkgJson.version ) === 'patch',
 			skipCommitsLink: Boolean( options.skipLinks ),
 			skipCompareLink: Boolean( options.skipLinks )
 		};
@@ -434,13 +455,25 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 		}
 	}
 
+	async function getChangelogForNextVersion() {
+		const changesFromCommits = await generateChangelogFromCommits();
+		const dependenciesSummary = generateSummaryOfChangesInPackages();
+
+		return [
+			changelogUtils.changelogHeader,
+			changesFromCommits.trim(),
+			'\n\n',
+			dependenciesSummary
+		].join( '' );
+	}
+
 	/**
 	 * Combines the generated changes based on commits and summary of version changes in packages.
 	 * Appends those changes at the beginning of the changelog file.
 	 *
 	 * @param {String} changesFromCommits Generated entries based on commits.
 	 */
-	function saveChangelog( changesFromCommits ) {
+	async function saveChangelog() {
 		logProcess( 'Saving changelog...' );
 
 		if ( !fs.existsSync( changelogUtils.changelogFile ) ) {
@@ -451,20 +484,15 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 
 		logInfo( 'Preparing a summary of version changes in packages.', { indentLevel: 1 } );
 
-		const dependenciesSummary = generateSummaryOfChangesInPackages();
-
 		let currentChangelog = changelogUtils.getChangelog();
 
+		const nextVersionChangelog = await getChangelogForNextVersion();
+
 		// Remove header from current changelog.
 		currentChangelog = currentChangelog.replace( changelogUtils.changelogHeader, '' ).trim();
 
 		// Concat header, new entries and old changelog to single string.
-		let newChangelog = changelogUtils.changelogHeader +
-			changesFromCommits.trim() +
-			'\n\n' +
-			dependenciesSummary +
-			'\n\n\n' +
-			currentChangelog;
+		let newChangelog = nextVersionChangelog + '\n\n\n' + currentChangelog;
 
 		newChangelog = newChangelog.trim() + '\n';
 
@@ -487,7 +515,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 
 		for ( const [ packageName, nextVersion ] of packagesVersion ) {
 			// Skip the package hosted in the main repository.
-			if ( packageName === pkgJson.name ) {
+			if ( packageName === rootPkgJson.name ) {
 				continue;
 			}
 
@@ -642,7 +670,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 	 * @returns {String}
 	 */
 	function formatChangelogEntry( packageName, nextVersion, currentVersion = null ) {
-		const npmUrl = `https://www.npmjs.com/package/${ packageName }`;
+		const npmUrl = `https://www.npmjs.com/package/${ packageName }/v/${ nextVersion }`;
 
 		if ( currentVersion ) {
 			return `* [${ packageName }](${ npmUrl }): v${ currentVersion } => v${ nextVersion }`;
@@ -661,7 +689,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 		return compareFunc( item => {
 			if ( Array.isArray( item[ scopeField ] ) ) {
 				// A hack that allows moving all scoped commits from the main repository/package at the beginning of the list.
-				if ( item[ scopeField ][ 0 ] === pkgJson.name ) {
+				if ( item[ scopeField ][ 0 ] === rootPkgJson.name ) {
 					return 'a'.repeat( 15 );
 				}
 

package/lib/tasks/updateversions.js

@@ -9,7 +9,7 @@ const { glob } = require( 'glob' );
 const fs = require( 'fs-extra' );
 const semver = require( 'semver' );
 const { normalizeTrim, toUnix, dirname, join } = require( 'upath' );
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+const checkVersionAvailability = require( '../utils/checkversionavailability' );
 
 /**
  * The purpose of the script is to update the version of a root package found in the current working
@@ -38,10 +38,18 @@ module.exports = async function updateVersions( { packagesDirectory, version, cw
 	const randomPackagePath = getRandomPackagePath( pkgJsonPaths, normalizedPackagesDir );
 
 	const rootPackageJson = join( normalizedCwd, 'package.json' );
+	const rootPackageVersion = ( await fs.readJson( rootPackageJson ) ).version;
+
 	const randomPackageJson = join( randomPackagePath, 'package.json' );
+	const randomPackageName = ( await fs.readJson( randomPackageJson ) ).name;
+
+	checkIfVersionIsValid( version, rootPackageVersion );
 
-	checkIfVersionIsValid( version, ( await fs.readJson( rootPackageJson ) ).version );
-	await checkVersionAvailability( version, ( await fs.readJson( randomPackageJson ) ).name );
+	const isVersionAvailable = await checkVersionAvailability( version, randomPackageName );
+
+	if ( !isVersionAvailable ) {
+		throw new Error( `The "${ randomPackageName }@${ version }" already exists in the npm registry.` );
+	}
 
 	for ( const pkgJsonPath of pkgJsonPaths ) {
 		const pkgJson = await fs.readJson( pkgJsonPath );
@@ -96,22 +104,3 @@ function checkIfVersionIsValid( newVersion, currentVersion ) {
 		throw new Error( `Provided version ${ newVersion } must be greater than ${ currentVersion } or match pattern 0.0.0-nightly.` );
 	}
 }
-
-/**
- * Checks if the provided version is not used in npm and there will be no errors when calling publish.
- *
- * @param {String} version
- * @param {String} packageName
- * @returns {Promise}
- */
-async function checkVersionAvailability( version, packageName ) {
-	return tools.shExec( `npm show ${ packageName }@${ version } version`, { verbosity: 'silent', async: true } )
-		.then( () => {
-			throw new Error( `Provided version ${ version } is already used in npm by ${ packageName }.` );
-		} )
-		.catch( err => {
-			if ( !err.toString().includes( 'is not in this registry' ) ) {
-				throw err;
-			}
-		} );
-}

package/lib/utils/checkversionavailability.js

@@ -0,0 +1,42 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+
+/**
+ * Checks if the provided version for the package exists in the npm registry.
+ *
+ * Returns a promise that resolves to `true` if the provided version does not exist or resolves the promise to `false` otherwise.
+ * If the `npm show` command exits with an error, it is re-thrown.
+ *
+ * @param {String} version
+ * @param {String} packageName
+ * @returns {Promise}
+ */
+module.exports = async function checkVersionAvailability( version, packageName ) {
+	return tools.shExec( `npm show ${ packageName }@${ version } version`, { verbosity: 'silent', async: true } )
+		.then( result => {
+			// Explicit check for npm < 8.13.0, which does not return anything (an empty result) and it exits with a zero status code when
+			// the version for the provided package does not exist in the npm registry.
+			if ( !result ) {
+				return true;
+			}
+
+			// Provided version exists in the npm registry.
+			return false;
+		} )
+		.catch( error => {
+			// All errors except the "E404" are re-thrown.
+			if ( !error.toString().includes( 'npm ERR! code E404' ) ) {
+				throw error;
+			}
+
+			// Npm >= 8.13.0 throws an "E404" error if a version does not exist.
+			// Npm < 8.13.0 should never reach this line.
+			return true;
+		} );
+};

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "38.1.4",
+  "version": "38.2.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "main": "lib/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^38.1.4",
+    "@ckeditor/ckeditor5-dev-utils": "^38.2.0",
     "@octokit/rest": "^19.0.0",
     "chalk": "^4.0.0",
     "cli-table": "^0.3.1",