@ckeditor/ckeditor5-dev-release-tools 38.0.0 → 38.0.2

package/lib/tasks/cleanuppackages.js

@@ -24,11 +24,12 @@ const { glob } = require( 'glob' );
  * @param {Object} options
  * @param {String} options.packagesDirectory Relative path to a location of packages to be cleaned up.
  * @param {Array.<String>} [options.packageJsonFieldsToRemove] Fields to remove from `package.json`. If not set, a predefined list is used.
+ * @param {Boolean} [options.preservePostInstallHook] Whether to preserve the postinstall hook in `package.json`.
  * @param {String} [options.cwd] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
 module.exports = async function cleanUpPackages( options ) {
-	const { packagesDirectory, packageJsonFieldsToRemove, cwd } = parseOptions( options );
+	const { packagesDirectory, packageJsonFieldsToRemove, preservePostInstallHook, cwd } = parseOptions( options );
 
 	const packageJsonPaths = await glob( '*/package.json', {
 		cwd: upath.join( cwd, packagesDirectory ),
@@ -41,7 +42,7 @@ module.exports = async function cleanUpPackages( options ) {
 		const packageJson = await fs.readJson( packageJsonPath );
 
 		await cleanUpPackageDirectory( packageJson, packagePath );
-		cleanUpPackageJson( packageJson, packageJsonFieldsToRemove );
+		cleanUpPackageJson( packageJson, packageJsonFieldsToRemove, preservePostInstallHook );
 
 		await fs.writeJson( packageJsonPath, packageJson, { spaces: 2 } );
 	}
@@ -53,6 +54,7 @@ module.exports = async function cleanUpPackages( options ) {
  * @param {Object} options
  * @param {String} options.packagesDirectory
  * @param {Array.<String>} [options.packageJsonFieldsToRemove=['devDependencies','depcheckIgnore','scripts','private']]
+ * @param {Boolean} [options.preservePostInstallHook]
  * @param {String} [options.cwd=process.cwd()]
  * @returns {Object}
  */
@@ -60,12 +62,14 @@ function parseOptions( options ) {
 	const {
 		packagesDirectory,
 		packageJsonFieldsToRemove = [ 'devDependencies', 'depcheckIgnore', 'scripts', 'private' ],
+		preservePostInstallHook = false,
 		cwd = process.cwd()
 	} = options;
 
 	return {
 		packagesDirectory: upath.normalizeTrim( packagesDirectory ),
 		packageJsonFieldsToRemove,
+		preservePostInstallHook,
 		cwd: upath.normalizeTrim( cwd )
 	};
 }
@@ -151,10 +155,17 @@ function getIgnoredFilePatterns( packageJson ) {
  *
  * @param {Object} packageJson
  * @param {Array.<String>} packageJsonFieldsToRemove
+ * @param {Boolean} preservePostInstallHook
  */
-function cleanUpPackageJson( packageJson, packageJsonFieldsToRemove ) {
+function cleanUpPackageJson( packageJson, packageJsonFieldsToRemove, preservePostInstallHook ) {
 	for ( const key of Object.keys( packageJson ) ) {
-		if ( packageJsonFieldsToRemove.includes( key ) ) {
+		if ( !packageJsonFieldsToRemove.includes( key ) ) {
+			continue;
+		}
+
+		if ( key === 'scripts' && preservePostInstallHook && packageJson.scripts.postinstall ) {
+			packageJson.scripts = { 'postinstall': packageJson.scripts.postinstall };
+		} else {
 			delete packageJson[ key ];
 		}
 	}

package/lib/tasks/generatechangelogformonorepository.js

@@ -49,10 +49,6 @@ const noteInfo = `[ℹ️](${ VERSIONING_POLICY_URL }#major-and-minor-breaking-c
  *
  * @param {String} [options.from] A commit or tag name that will be the first param of the range of commits to collect.
  *
- * @param {Boolean} [options.highlightsPlaceholder=false] Whether to add a note about release highlights.
- *
- * @param {Boolean} [options.collaborationFeatures=false] Whether to add a note about collaboration features.
- *
  * @param {String} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
  *
  * @param {Array.<ExternalRepository>} [options.externalRepositories=[]] An array of object with additional repositories
@@ -386,10 +382,8 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 			commit: 'commit',
 			repoUrl: getRepositoryUrl( options.cwd ),
 			currentTag: 'v' + version,
-			previousTag: 'v' + pkgJson.version,
+			previousTag: options.from ? options.from : 'v' + pkgJson.version,
 			isPatch: semver.diff( version, pkgJson.version ) === 'patch',
-			highlightsPlaceholder: options.highlightsPlaceholder || false,
-			collaborationFeatures: options.collaborationFeatures || false,
 			skipCommitsLink: Boolean( options.skipLinks ),
 			skipCompareLink: Boolean( options.skipLinks )
 		};
@@ -503,6 +497,8 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 			} );
 		}
 
+		// When the `--from` flag is specified, we want to use its value as the "current version".
+		const currentVersion = options.from ? options.from.replace( /^v/, '' ) : null;
 		const newPackages = getNewPackages( dependencies );
 		const majorBreakingChangesPackages = getPackagesMatchedToScopesFromNotes( dependencies, 'MAJOR BREAKING CHANGES' );
 		const minorBreakingChangesPackages = getPackagesMatchedToScopesFromNotes( dependencies, 'MINOR BREAKING CHANGES' );
@@ -527,7 +523,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 			entries.push( '\nMajor releases (contain major breaking changes):\n' );
 
 			for ( const [ packageName, version ] of [ ...majorBreakingChangesPackages ].sort( sortByPackageName ) ) {
-				entries.push( formatChangelogEntry( packageName, version.next, version.current ) );
+				entries.push( formatChangelogEntry( packageName, version.next, currentVersion || version.current ) );
 			}
 		}
 
@@ -535,7 +531,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 			entries.push( '\nMinor releases (contain minor breaking changes):\n' );
 
 			for ( const [ packageName, version ] of [ ...minorBreakingChangesPackages ].sort( sortByPackageName ) ) {
-				entries.push( formatChangelogEntry( packageName, version.next, version.current ) );
+				entries.push( formatChangelogEntry( packageName, version.next, currentVersion || version.current ) );
 			}
 		}
 
@@ -543,7 +539,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 			entries.push( '\nReleases containing new features:\n' );
 
 			for ( const [ packageName, version ] of [ ...newFeaturesPackages ].sort( sortByPackageName ) ) {
-				entries.push( formatChangelogEntry( packageName, version.next, version.current ) );
+				entries.push( formatChangelogEntry( packageName, version.next, currentVersion || version.current ) );
 			}
 		}
 
@@ -551,7 +547,7 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 			entries.push( '\nOther releases:\n' );
 
 			for ( const [ packageName, version ] of [ ...dependencies ].sort( sortByPackageName ) ) {
-				entries.push( formatChangelogEntry( packageName, version.next, version.current ) );
+				entries.push( formatChangelogEntry( packageName, version.next, currentVersion || version.current ) );
 			}
 		}
 

package/lib/tasks/generatechangelogforsinglepackage.js

@@ -33,10 +33,6 @@ const SKIP_GENERATE_CHANGELOG = 'Typed "skip" as a new version. Aborting.';
  *
  * @param {String} [options.from] A commit or tag name that will be the first param of the range of commits to collect.
  *
- * @param {Boolean} [options.highlightsPlaceholder=false] Whether to add a note about release highlights.
- *
- * @param {Boolean} [options.collaborationFeatures=false] Whether to add a note about collaboration features.
- *
  * @param {String} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
  *
  * @returns {Promise}
@@ -97,18 +93,14 @@ module.exports = async function generateChangelogForSinglePackage( options = {}
 
 			logProcess( 'Generating the changelog...' );
 
-			const previousTag = commitOptions.from ? 'v' + pkgJson.version : null;
-
 			const writerContext = {
 				version,
 				commit: 'commit',
 				repoUrl: getRepositoryUrl(),
 				currentTag: 'v' + version,
-				previousTag,
+				previousTag: options.from ? options.from : 'v' + pkgJson.version,
 				isPatch: semver.diff( version, pkgJson.version ) === 'patch',
 				isInternalRelease,
-				highlightsPlaceholder: Boolean( options.highlightsPlaceholder ),
-				collaborationFeatures: Boolean( options.collaborationFeatures ),
 				skipCommitsLink: Boolean( options.skipLinks ),
 				skipCompareLink: Boolean( options.skipLinks )
 			};

package/lib/tasks/preparerepository.js

@@ -95,7 +95,8 @@ function validateRootPackage( packageJson ) {
  * @returns {Promise}
  */
 async function processRootPackage( { cwd, rootPackageJson, outputDirectoryPath } ) {
-	const rootPackageOutputPath = upath.join( outputDirectoryPath, rootPackageJson.name );
+	const rootPackageDirName = rootPackageJson.name.replace( /^@.*\//, '' );
+	const rootPackageOutputPath = upath.join( outputDirectoryPath, rootPackageDirName );
 	const pkgJsonOutputPath = upath.join( rootPackageOutputPath, 'package.json' );
 
 	await fs.ensureDir( rootPackageOutputPath );

package/lib/tasks/publishpackages.js

@@ -11,7 +11,8 @@ const assertNpmAuthorization = require( '../utils/assertnpmauthorization' );
 const assertPackages = require( '../utils/assertpackages' );
 const assertNpmTag = require( '../utils/assertnpmtag' );
 const assertFilesToPublish = require( '../utils/assertfilestopublish' );
-const publishPackagesOnNpm = require( '../utils/publishpackagesonnpm' );
+const executeInParallel = require( '../utils/executeinparallel' );
+const publishPackageOnNpmCallback = require( '../utils/publishpackageonnpmcallback' );
 
 /**
  * The purpose of the script is to validate the packages prepared for the release and then release them on npm.
@@ -29,6 +30,7 @@ const publishPackagesOnNpm = require( '../utils/publishpackagesonnpm' );
  * @param {String} options.packagesDirectory Relative path to a location of packages to release.
  * @param {String} options.npmOwner The account name on npm, which should be used to publish the packages.
  * @param {ListrTaskObject} options.listrTask An instance of `ListrTask`.
+ * @param {AbortSignal|null} [options.signal=null] Signal to abort the asynchronous process.
  * @param {String} [options.npmTag='staging'] The npm distribution tag.
  * @param {Object.<String, Array.<String>>|null} [options.optionalEntries=null] Specifies which entries from the `files` field in the
  * `package.json` are optional. The key is a package name, and its value is an array of optional entries from the `files` field, for which
@@ -37,6 +39,7 @@ const publishPackagesOnNpm = require( '../utils/publishpackagesonnpm' );
  * @param {String} [options.confirmationCallback=null] An callback whose response decides to continue the publishing packages. Synchronous
  * and asynchronous callbacks are supported.
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
+ * @param {Number} [options.concurrency=4] Number of CPUs that will execute the task.
  * @returns {Promise}
  */
 module.exports = async function publishPackages( options ) {
@@ -44,10 +47,12 @@ module.exports = async function publishPackages( options ) {
 		packagesDirectory,
 		npmOwner,
 		listrTask,
+		signal = null,
 		npmTag = 'staging',
 		optionalEntries = null,
 		confirmationCallback = null,
-		cwd = process.cwd()
+		cwd = process.cwd(),
+		concurrency = 4
 	} = options;
 
 	await assertNpmAuthorization( npmOwner );
@@ -64,6 +69,15 @@ module.exports = async function publishPackages( options ) {
 	const shouldPublishPackages = confirmationCallback ? await confirmationCallback() : true;
 
 	if ( shouldPublishPackages ) {
-		await publishPackagesOnNpm( packagePaths, npmTag, listrTask );
+		await executeInParallel( {
+			packagesDirectory,
+			listrTask,
+			taskToExecute: publishPackageOnNpmCallback,
+			taskOptions: {
+				npmTag
+			},
+			signal,
+			concurrency
+		} );
 	}
 };

package/lib/templates/template.hbs

@@ -5,18 +5,6 @@ Internal changes only (updated dependencies, documentation, etc.).
 
 
 {{else}}
-{{#if highlightsPlaceholder}}
-### Release highlights
-
-<!-- TODO: Add a link to the blog post. -->
-
-{{/if}}
-{{#if collaborationFeatures}}
-### Collaboration features
-
-The CKEditor 5 Collaboration features changelog can be found here: https://ckeditor.com/collaboration/changelog.
-
-{{/if}}
 {{> footer}}
 {{#each commitGroups}}
 ### {{title}}

package/lib/utils/abortcontroller.js

@@ -0,0 +1,47 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* eslint-env node */
+
+'use strict';
+
+/**
+ * Creates an AbortController instance and registers the listener function on SIGINT event that aborts the asynchronous process.
+ *
+ * @returns {AbortController}
+ */
+function registerAbortController() {
+	const abortController = new AbortController();
+
+	const listener = () => {
+		abortController.abort( 'SIGINT' );
+	};
+
+	abortController._listener = listener;
+
+	// Add the listener function to the beginning of the listeners array for the SIGINT event. Listr2 has own SIGINT listener that
+	// terminates the process, so in order to abort our asynchronous workers, our listener must be executed first.
+	process.prependOnceListener( 'SIGINT', abortController._listener );
+
+	return abortController;
+}
+
+/**
+ * Deregisters the previously registered listener function on SIGINT event from the given AbortController instance.
+ *
+ * @param {AbortController} abortController
+ */
+function deregisterAbortController( abortController ) {
+	if ( !abortController || !abortController._listener ) {
+		return;
+	}
+
+	process.removeListener( 'SIGINT', abortController._listener );
+}
+
+module.exports = {
+	registerAbortController,
+	deregisterAbortController
+};

package/lib/utils/executeinparallel.js

@@ -12,6 +12,7 @@ const upath = require( 'upath' );
 const fs = require( 'fs/promises' );
 const { Worker } = require( 'worker_threads' );
 const { glob } = require( 'glob' );
+const { registerAbortController, deregisterAbortController } = require( './abortcontroller' );
 
 const WORKER_SCRIPT = upath.join( __dirname, 'parallelworker.js' );
 
@@ -27,9 +28,10 @@ const WORKER_SCRIPT = upath.join( __dirname, 'parallelworker.js' );
  * @param {String} options.packagesDirectory Relative path to a location of packages to execute a task.
  * @param {Function} options.taskToExecute A callback that is executed on all found packages.
  * It receives an absolute path to a package as an argument. It can be synchronous or may return a promise.
- * @param {AbortSignal} options.signal Signal to abort the asynchronous process.
  * @param {ListrTaskObject} options.listrTask An instance of `ListrTask`.
- * @param {Function} [options.packagesDirectoryFilter] A function that is executed for each found package directory to filter out those
+ * @param {AbortSignal|null} [options.signal=null] Signal to abort the asynchronous process. If not set, default AbortController is created.
+ * @param {Object} [options.taskOptions=null] Optional data required by the task.
+ * @param {Function} [options.packagesDirectoryFilter=null] A function that is executed for each found package directory to filter out those
  * that do not require executing a task. It should return a truthy value to keep the package and a falsy value to skip the package from
  * processing.
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
@@ -39,19 +41,20 @@ const WORKER_SCRIPT = upath.join( __dirname, 'parallelworker.js' );
 module.exports = async function executeInParallel( options ) {
 	const {
 		packagesDirectory,
-		signal,
 		taskToExecute,
 		listrTask,
+		signal = null,
+		taskOptions = null,
 		packagesDirectoryFilter = null,
 		cwd = process.cwd(),
 		concurrency = require( 'os' ).cpus().length / 2
 	} = options;
 
 	const normalizedCwd = upath.toUnix( cwd );
-	const packages = await glob( `${ packagesDirectory }/*/`, {
+	const packages = ( await glob( `${ packagesDirectory }/*/`, {
 		cwd: normalizedCwd,
 		absolute: true
-	} );
+	} ) ).map( upath.normalize );
 
 	const packagesToProcess = packagesDirectoryFilter ?
 		packages.filter( packagesDirectoryFilter ) :
@@ -64,11 +67,17 @@ module.exports = async function executeInParallel( options ) {
 
 	const onPackageDone = progressFactory( listrTask, packagesToProcess.length );
 
+	let defaultAbortController;
+
+	if ( !signal ) {
+		defaultAbortController = registerAbortController();
+	}
+
 	const workers = packagesInThreads.map( packages => {
 		return createWorker( {
-			signal,
+			signal: signal || defaultAbortController.signal,
 			onPackageDone,
-			workerData: { packages, callbackModule }
+			workerData: { packages, callbackModule, taskOptions }
 		} );
 	} );
 
@@ -83,6 +92,10 @@ module.exports = async function executeInParallel( options ) {
 		} )
 		.finally( async () => {
 			await fs.unlink( callbackModule );
+
+			if ( defaultAbortController ) {
+				deregisterAbortController( defaultAbortController );
+			}
 		} );
 };
 

package/lib/utils/generatechangelog.js

@@ -22,8 +22,6 @@ const UPDATED_TRANSLATION_COMMIT = '* Updated translations.';
  * @param {String} context.currentTag A tag for the current version.
  * @param {String} context.commit Commit keyword in the URL.
  * @param {String} [context.previousTag] A tag for the previous version.
- * @param {Boolean} [options.highlightsPlaceholder=false] Whether to add a note about release highlights.
- * @param {Boolean} [options.collaborationFeatures=false] Whether to add a note about collaboration features.
  * @param {Boolean} [context.skipCommitsLink=false] Whether to skip adding links to commit.
  * @param {Boolean} [context.skipCompareLink=false] Whether to remove the compare URL in the header.
  *

package/lib/utils/parallelworker.js

@@ -17,7 +17,7 @@
 	const callback = require( workerData.callbackModule );
 
 	for ( const packagePath of workerData.packages ) {
-		await callback( packagePath );
+		await callback( packagePath, workerData.taskOptions );
 
 		// To increase the status log.
 		parentPort.postMessage( 'done:package' );

package/lib/utils/publishpackageonnpmcallback.js

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* eslint-env node */
+
+'use strict';
+
+/**
+ * Calls the npm command to publish the package. When a package is successfully published, it is removed from the filesystem.
+ *
+ * @param {String} packagePath
+ * @param {Object} taskOptions
+ * @param {String} taskOptions.npmTag
+ * @returns {Promise}
+ */
+module.exports = async function publishPackageOnNpmCallback( packagePath, taskOptions ) {
+	const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+	const upath = require( 'upath' );
+	const fs = require( 'fs-extra' );
+
+	await tools.shExec( `npm publish --access=public --tag ${ taskOptions.npmTag }`, { cwd: packagePath, async: true, verbosity: 'error' } )
+		.catch( () => {
+			const packageName = upath.basename( packagePath );
+
+			throw new Error( `Unable to publish "${ packageName }" package.` );
+		} );
+
+	await fs.remove( packagePath );
+};

package/package.json

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

package/lib/utils/publishpackagesonnpm.js

@@ -1,35 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-'use strict';
-
-const fs = require( 'fs-extra' );
-const upath = require( 'upath' );
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-
-/**
- * Calls the npm command to publish all packages. When a package is successfully published, it is removed from the filesystem.
- *
- * @param {Array.<String>} packagePaths
- * @param {String} npmTag
- * @param {ListrTaskObject} listrTask
- * @returns {Promise}
- */
-module.exports = async function publishPackagesOnNpm( packagePaths, npmTag, listrTask ) {
-	let index = 0;
-
-	for ( const packagePath of packagePaths ) {
-		listrTask.output = `Status: ${ ++index }/${ packagePaths.length }. Processing the "${ upath.basename( packagePath ) }" directory.`;
-
-		await tools.shExec( `npm publish --access=public --tag ${ npmTag }`, { cwd: packagePath, async: true, verbosity: 'error' } )
-			.catch( () => {
-				const packageName = upath.basename( packagePath );
-
-				throw new Error( `Unable to publish "${ packageName }" package.` );
-			} );
-
-		await fs.remove( packagePath );
-	}
-};