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

package/lib/tasks/bumpversions.js

@@ -1,354 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-'use strict';
-
-const path = require( 'path' );
-const chalk = require( 'chalk' );
-const { tools, logger } = require( '@ckeditor/ckeditor5-dev-utils' );
-const cli = require( '../utils/cli' );
-const versions = require( '../utils/versions' );
-const changelog = require( '../utils/changelog' );
-const displaySkippedPackages = require( '../utils/displayskippedpackages' );
-const executeOnPackages = require( '../utils/executeonpackages' );
-const getPackageJson = require( '../utils/getpackagejson' );
-const getPackagesToRelease = require( '../utils/getpackagestorelease' );
-const getPackagesPaths = require( '../utils/getpackagespaths' );
-const updateDependenciesVersions = require( '../utils/updatedependenciesversions' );
-const validatePackageToRelease = require( '../utils/validatepackagetorelease' );
-
-const BREAK_RELEASE_MESSAGE = 'You aborted updating versions. Why? Oh why?!';
-
-/**
- * Updates version of all subpackages found in specified path.
- *
- * This task does:
- *   - finds paths to subpackages,
- *   - updates versions of all dependencies (even if some packages will not be released, its version will be updated in released packages),
- *   - bumps version of all packages.
- *
- * @param {String} options.cwd Current working directory (packages) from which all paths will be resolved.
- * @param {String|null} options.packages Where to look for other packages (dependencies). If `null`, only repository specified under
- * `options.cwd` will be used in the task.
- * @param {Array.<String>} [options.skipPackages=[]] Name of packages which won't be touched.
- * @param {Boolean} [options.dryRun=false] If set on true, all changes will be printed on the screen. Changes produced by commands like
- * `npm version` will be reverted. Every called command will be displayed.
- * @param {Boolean} [options.skipMainRepository=false] If set on true, package found in "cwd" will be skipped.
- * @param {String} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
- * @param {String} [options.changelogDirectory] An absolute path to the directory where the `CHANGELOG.md` file is saved. If not specified,
- * the `options.cwd` value will be used instead.
- * @param {Boolean} [options.skipUpdatingDependencies=false] Whether to skip updating version of dependencies between updated packages.
- * @returns {Promise} A collection with packages that were updated.
- */
-module.exports = async function bumpVersions( options ) {
-	const cwd = process.cwd();
-	const log = logger();
-
-	const dryRun = Boolean( options.dryRun );
-
-	const pathsCollection = getPackagesPaths( {
-		cwd: options.cwd,
-		packages: options.packages,
-		skipPackages: options.skipPackages || [],
-		skipMainRepository: options.skipMainRepository
-	} );
-
-	const changelogDirectory = options.changelogDirectory || options.cwd;
-
-	const mainRepositoryVersion = versions.getLastFromChangelog( changelogDirectory );
-	const mainChangelog = changelog.getChangesForVersion( mainRepositoryVersion, changelogDirectory );
-	const releaseBranch = options.releaseBranch || 'master';
-
-	logDryRun( '⚠️  DRY RUN mode ⚠️' );
-	logDryRun( 'All changes made by this script will be reverted automatically.' );
-	logProcess( 'Collecting packages which versions should be updated...' );
-
-	// In order to avoid setting global variables, every function passes `packages` variable to another function.
-
-	return getPackagesToRelease( pathsCollection.matched, { changes: mainChangelog, version: mainRepositoryVersion } )
-		.then( packages => isAnythingForRelease( packages ) )
-		.then( packages => confirmUpdate( packages ) )
-		.then( packages => prepareDependenciesVersions( packages ) )
-		.then( ( { packages, dependencies } ) => filterPackagesThatWillNotBeReleased( packages, dependencies ) )
-		.then( ( { packages, dependencies } ) => updateDependenciesOfPackages( packages, dependencies ) )
-		.then( packages => updateLatestChangesForMainRepository( packages, mainRepositoryVersion ) )
-		.then( packages => validateRepository( packages ) )
-		.then( packages => bumpVersion( packages ) )
-		.then( () => {
-			process.chdir( cwd );
-
-			logProcess( `Finished updating versions of ${ chalk.underline( pathsCollection.matched.size ) } package(s).` );
-			logDryRun( 'Because of the DRY RUN mode, nothing has been changed. All changes were reverted.' );
-
-			return Promise.resolve( pathsCollection.matched );
-		} )
-		.catch( err => {
-			process.chdir( cwd );
-
-			// A user did not confirm the release process.
-			if ( err instanceof Error && err.message === BREAK_RELEASE_MESSAGE ) {
-				logProcess( 'Updating has been aborted.' );
-
-				return Promise.resolve();
-			}
-
-			log.error( err.message );
-
-			process.exitCode = -1;
-		} );
-
-	// Displays packages that won't match to specified criteria and checks whether there is at least one package
-	// that should update its version.
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @returns {Map.<String, ReleaseDetails>}
-	function isAnythingForRelease( packages ) {
-		logProcess( 'Checking whether is there anything for updating...' );
-
-		displaySkippedPackages( pathsCollection.skipped );
-
-		if ( packages.size === 0 ) {
-			throw new Error( 'None of the packages contains any changes since its last release. Aborting.' );
-		}
-
-		return packages;
-	}
-
-	// Asks a user whether the process should be continued.
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @returns {Promise.<Map.<String, ReleaseDetails>>}
-	function confirmUpdate( packages ) {
-		logProcess( 'Should we continue?' );
-
-		return cli.confirmUpdatingVersions( packages )
-			.then( isConfirmed => {
-				if ( !isConfirmed ) {
-					throw new Error( BREAK_RELEASE_MESSAGE );
-				}
-
-				return packages;
-			} );
-	}
-
-	// Prepare a map that contains new versions of packages. It will be used for updating dependencies' version during the release.
-	//
-	// This map contains new versions of all packages that will be released and current version of all packages which won't match to
-	// specified criteria or won't be released (no changes between current and previous release).
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @returns {Object}
-	function prepareDependenciesVersions( packages ) {
-		logProcess( 'Preparing to updating versions of dependencies...' );
-
-		const dependencies = new Map();
-
-		// For every package that will be released, save its name and the latest version.
-		for ( const [ packageName, { version } ] of packages ) {
-			dependencies.set( packageName, version );
-		}
-
-		// Packages which won't match to specified criteria won't be released but we want to update their
-		// versions in packages where skipped packages are defined as dependencies.
-		for ( const packagePath of pathsCollection.skipped ) {
-			const packageJson = getPackageJson( packagePath );
-
-			dependencies.set( packageJson.name, packageJson.version );
-		}
-
-		// Even if some packages match to specified criteria but won't be releases because of no changes,
-		// we want to update their version in packages where they are defined as dependency.
-		for ( const packagePath of pathsCollection.matched ) {
-			const packageJson = getPackageJson( packagePath );
-
-			if ( !dependencies.has( packageJson.name ) ) {
-				dependencies.set( packageJson.name, packageJson.version );
-			}
-		}
-
-		return { packages, dependencies };
-	}
-
-	// Filter out packages which won't be released.
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @params {Map} dependencies
-	// @returns {Object}
-	function filterPackagesThatWillNotBeReleased( packages, dependencies ) {
-		logDryRun( 'Filtering out packages that will not be updated...' );
-
-		for ( const pathToPackage of pathsCollection.matched ) {
-			const packageName = getPackageJson( pathToPackage ).name;
-
-			if ( !packages.has( packageName ) ) {
-				pathsCollection.matched.delete( pathToPackage );
-			}
-		}
-
-		return { packages, dependencies };
-	}
-
-	// Update versions of all dependencies.
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @params {Map} dependencies
-	// @returns {Promise.<Map.<String, ReleaseDetails>>}
-	function updateDependenciesOfPackages( packages, dependencies ) {
-		if ( options.skipUpdatingDependencies ) {
-			logProcess( 'Skipping updating dependencies...' );
-
-			return Promise.resolve( packages );
-		}
-
-		logProcess( 'Updating dependencies for packages that will be released...' );
-		let hasUpdatedAnyPackage = false;
-
-		return executeOnPackages( pathsCollection.matched, repositoryPath => {
-			process.chdir( repositoryPath );
-
-			const packageJson = getPackageJson( repositoryPath );
-
-			log.info( `\nUpdating dependencies for "${ chalk.underline( packageJson.name ) }"...` );
-
-			updateDependenciesVersions( dependencies, path.join( repositoryPath, 'package.json' ) );
-
-			if ( exec( 'git diff --name-only package.json' ).trim().length ) {
-				if ( dryRun ) {
-					logDryRun( 'These changes would be committed.' );
-
-					log.info( chalk.grey( exec( 'git diff --word-diff package.json' ) ) );
-					exec( 'git checkout package.json' );
-				} else {
-					hasUpdatedAnyPackage = true;
-
-					exec( 'git add package.json' );
-				}
-			}
-
-			return Promise.resolve();
-		} ).then( () => {
-			process.chdir( cwd );
-
-			if ( hasUpdatedAnyPackage ) {
-				exec( 'git commit -m "Internal: Updated dependencies. [skip ci]"' );
-			}
-
-			return packages;
-		} );
-	}
-
-	// Gather descriptions of the release for all packages.
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @returns {<Map.<String, ReleaseDetails>}
-	function updateLatestChangesForMainRepository( packages, changes ) {
-		logProcess( 'Updating changes for the main repository...' );
-
-		const packageJson = getPackageJson( options.cwd );
-		const releaseDetails = packages.get( packageJson.name );
-
-		releaseDetails.changes = changes;
-
-		return packages;
-	}
-
-	// Validate the main repository.
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @returns {Map.<String, ReleaseDetails>}
-	function validateRepository( packages ) {
-		logProcess( 'Validating the main repository...' );
-
-		const mainPackageJson = getPackageJson( options.cwd );
-		const releaseDetails = packages.get( mainPackageJson.name );
-
-		const errors = validatePackageToRelease( {
-			branch: releaseBranch,
-			changes: releaseDetails.changes,
-			version: releaseDetails.version
-		} );
-
-		if ( errors.length ) {
-			log.error( `‼️  ${ chalk.underline( mainPackageJson.name ) }` );
-			errors.forEach( err => {
-				log.error( '* ' + err );
-			} );
-
-			throw new Error( 'Updating has been aborted due to errors.' );
-		}
-
-		return packages;
-	}
-
-	// Updates versions of packages.
-	//
-	// @params {Map.<String, ReleaseDetails>} packages
-	// @returns {Promise.<Map.<String, ReleaseDetails>>}
-	function bumpVersion( packages ) {
-		logProcess( 'Tagging new versions of packages...' );
-
-		let numberOfCommitsBeforeVersioning;
-
-		// Based on number of commits before and after executing `npm version`, we will be able to revert all changes
-		// that have been done. It allows reverting changes done by npm `preversion` and/or `postversion` hooks.
-		if ( dryRun ) {
-			numberOfCommitsBeforeVersioning = Number( exec( 'git rev-list --count HEAD' ) );
-		}
-
-		return executeOnPackages( pathsCollection.matched, bumpVersionForSinglePackage )
-			.then( () => {
-				process.chdir( options.cwd );
-
-				const packageJson = getPackageJson( options.cwd );
-				const releaseDetails = packages.get( packageJson.name );
-
-				log.info( '\nCommitting and tagging changes...' );
-
-				exec( `git commit --message "Release: v${ releaseDetails.version }."` );
-				exec( `git tag v${ releaseDetails.version }` );
-
-				if ( dryRun ) {
-					const numberOfCommitsAfterVersioning = Number( exec( 'git rev-list --count HEAD' ) );
-					const commitsToRevert = numberOfCommitsAfterVersioning - numberOfCommitsBeforeVersioning;
-
-					logDryRun( `Reverting changes made by "npm version". Removing a tag and ${ commitsToRevert } commit(s).` );
-					exec( `git reset --hard HEAD~${ commitsToRevert }` );
-					exec( `git tag -d v${ releaseDetails.version }` );
-				}
-
-				return packages;
-			} );
-
-		function bumpVersionForSinglePackage( repositoryPath ) {
-			process.chdir( repositoryPath );
-
-			const packageJson = getPackageJson( repositoryPath );
-			const releaseDetails = packages.get( packageJson.name );
-
-			log.info( `\nBumping version for "${ chalk.underline( packageJson.name ) }"...` );
-
-			exec( `npm version ${ releaseDetails.version } --no-git-tag-version --no-workspaces-update` );
-			exec( 'git add .' );
-		}
-	}
-
-	function exec( command ) {
-		if ( dryRun ) {
-			log.info( `⚠️  ${ chalk.grey( 'Execute:' ) } "${ chalk.cyan( command ) }" in "${ chalk.grey.italic( process.cwd() ) }".` );
-		}
-
-		return tools.shExec( command, { verbosity: 'error' } );
-	}
-
-	function logProcess( message ) {
-		log.info( '\n📍 ' + chalk.cyan( message ) );
-	}
-
-	function logDryRun( message ) {
-		if ( dryRun ) {
-			log.info( 'ℹ️  ' + chalk.yellow( message ) );
-		}
-	}
-};

package/lib/tasks/preparepackages.js

@@ -1,257 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/* eslint-env node */
-
-'use strict';
-
-const path = require( 'path' );
-const fs = require( 'fs-extra' );
-const chalk = require( 'chalk' );
-const glob = require( 'glob' );
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-const { getLastFromChangelog } = require( '../utils/versions' );
-const executeOnPackages = require( '../utils/executeonpackages' );
-
-/**
- * Fields that will not be removed from `package.json` while preparing a package.
- */
-const PACKAGE_JSON_FIELDS = [
-	'author',
-	'dependencies',
-	'description',
-	'engine',
-	'homepage',
-	'license',
-	'keywords',
-	'name',
-	'version',
-	'files',
-	'main',
-	'types',
-	'scripts'
-];
-
-/**
- * Prepares packages to be released:
- *
- *  * removes TypeScript sources (but keeps typings),
- *  * secures the code of packages,
- *  * replaces the main package entry point (use JS file instead of TS),
- *  * prepares builds for all packages if a command is specified as npm script.
- *
- * The dry-run mode is not supported as the script creates a directory that should not be tracked by Git.
- *
- * @param {Object} options
- * @param {String} options.cwd Current working directory (packages) from which all paths will be resolved.
- * @param {String} options.packages Where to look for sources of packages (dependencies).
- * @param {String} options.releaseDirectory Where to copy the packages (dependencies).
- * @param {String} options.changelogDirectory An absolute path to the directory where the `CHANGELOG.md` file is saved.
- * @param {String} options.buildScript A name of npm script that builds the package. It is executed per package.
- * @param {String} options.secureScript A name of npm script that secures the code in the entire repository.
- * @param {Array.<String>} [options.npmScriptsToRemove=[]] An array of npm scripts that should be removed when processing a package.
- * @returns {Promise}
- */
-module.exports = async function preparePackages( options ) {
-	const cwd = process.cwd();
-	const packagesDirectory = path.join( options.cwd, options.packages );
-	const releaseDirectory = path.join( options.cwd, options.releaseDirectory );
-	const ckeditor5Version = getLastFromChangelog( options.changelogDirectory );
-	const npmScriptsToRemove = options.npmScriptsToRemove || [];
-
-	// Clean the release directory before doing anything.
-	logProcess( 'Removing the release directory...' );
-	await fs.remove( releaseDirectory );
-
-	// Copy packages to the temporary, release directory.
-	logProcess( 'Copying packages to release...' );
-	await fs.copy( packagesDirectory, releaseDirectory );
-
-	// Find all short package names in the release directory.
-	// Then, map the names to absolute paths and their `package.json`.
-	const directoryNames = ( await fs.readdir( releaseDirectory, { withFileTypes: true } ) )
-		.filter( dirent => dirent.isDirectory() )
-		.map( dirent => dirent.name )
-		.map( name => {
-			const packagePath = path.join( releaseDirectory, name );
-			const packageJson = require( path.join( packagePath, 'package.json' ) );
-
-			return [ packagePath, packageJson ];
-		} );
-
-	const packages = new Map( directoryNames );
-
-	// Filter out packages without changes. They won't be released.
-	logProcess( 'Verifying packages...' );
-	await filterOutPackagesWithoutChanges( packages, ckeditor5Version );
-
-	if ( !packages.size ) {
-		logProcess( 'Nothing to release. Aborting.' );
-		return;
-	}
-
-	logProcess( 'Preparing packages...' );
-	await preparePackagesToBeReleased( packages, npmScriptsToRemove );
-
-	// Secure the entire release directory.
-	logProcess( 'Securing the code...' );
-	exec( options.secureScript );
-
-	logProcess( 'Preparing builds...' );
-	await prepareBuilds( packages, options.buildScript );
-
-	process.chdir( cwd );
-
-	logProcess( 'Done.' );
-	logInfo( chalk.grey( `Review the "${ options.releaseDirectory }/" directory before publishing the packages on npm.\n` ) );
-};
-
-/**
- * Check if packages should be released. It compares the packages' version against the latest version in CKEditor 5 changelog.
- *
- * If they are different, it means that a package should not be released and it is removed from the release directory.
- *
- * @param {Map.<String, PackageJson>} packages
- * @param {String} ckeditor5Version
- * @returns {Promise}
- */
-function filterOutPackagesWithoutChanges( packages, ckeditor5Version ) {
-	return executeOnPackages( packages.keys(), async packagePath => {
-		const { name: packageName, version: packageVersion } = packages.get( packagePath );
-
-		logInfo( `* Checking "${ chalk.underline( packageName ) }"...`, { indent: 1, startWithNewLine: true } );
-
-		if ( packageVersion !== ckeditor5Version ) {
-			logInfo( chalk.grey( 'Nothing to release. Skipping.' ), { indent: 1 } );
-
-			await fs.remove( packagePath );
-			packages.delete( packagePath );
-		}
-	} );
-}
-
-/**
- * Prepare packages to be released. It means, for each package we do the following actions:
- *
- *   * Remove TypeScript sources, but keep typing files (`.d.ts`).
- *   * Redefine the main script of a package. Replace the TypeScript extension with JavaScript.
- *   * Remove all tests of the package as they should not be released.
- *   * Remove the `build/` directory. The build script will re-create it from the JavaScript code.
- *
- * @param {Map.<String, PackageJson>} packages
- * @param {Array.<String>} npmScriptsToRemove An array of npm scripts that should be removed when processing a package.
- * @returns {Promise}
- */
-function preparePackagesToBeReleased( packages, npmScriptsToRemove ) {
-	return executeOnPackages( packages.keys(), async packagePath => {
-		const { name: packageName } = packages.get( packagePath );
-
-		logInfo( `* Processing "${ chalk.underline( packageName ) }"...`, { indent: 1, startWithNewLine: true } );
-		logInfo( chalk.grey( 'Cleaning-up the package directory...' ), { indent: 2 } );
-
-		// The build will be refreshed. To avoid weird caches or building from TypeScript, let's clean the directory.
-		await fs.remove( path.join( packagePath, 'build' ) );
-
-		// Tests will not be published anyway. To increase readability, let's clean it too.
-		await fs.remove( path.join( packagePath, 'tests' ) );
-
-		// Update the entry point in the `package.json` file to point to a JavaScript file.
-		logInfo( chalk.grey( 'Replacing the package entry point (TS => JS)...' ), { indent: 2 } );
-
-		tools.updateJSONFile( path.join( packagePath, 'package.json' ), packageJson => {
-			const { main } = packageJson;
-
-			// Remove properties from package.json that are not related to the production package.
-			for ( const property of Object.keys( packageJson ) ) {
-				if ( !PACKAGE_JSON_FIELDS.includes( property ) ) {
-					delete packageJson[ property ];
-				}
-			}
-
-			if ( 'scripts' in packageJson ) {
-				for ( const npmScript of npmScriptsToRemove ) {
-					delete packageJson.scripts[ npmScript ];
-				}
-			}
-
-			if ( !main ) {
-				return packageJson;
-			}
-
-			packageJson.main = main.replace( /.ts$/, '.js' );
-			packageJson.types = main.replace( /.ts$/, '.d.ts' );
-
-			return packageJson;
-		} );
-
-		// Find all TypeScript sources...
-		const typescriptFiles = await new Promise( ( resolve, reject ) => {
-			glob( '**/*.ts', { cwd: packagePath }, ( err, files ) => {
-				return err ? reject( err ) : resolve( files );
-			} );
-		} );
-
-		logInfo( chalk.grey( 'Removing TypeScript sources...' ), { indent: 2 } );
-
-		// ...and remove all non-typing files.
-		for ( const tsFile of typescriptFiles ) {
-			if ( !tsFile.endsWith( '.d.ts' ) ) {
-				await fs.remove( path.join( packagePath, tsFile ) );
-			}
-		}
-	} );
-}
-
-/**
- * Executed a build task for all packages.
- *
- * @param {Map.<String, PackageJson>} packages
- * @param {String} buildScript
- * @returns {Promise}
- */
-function prepareBuilds( packages, buildScript ) {
-	return executeOnPackages( packages.keys(), async packagePath => {
-		const { name: packageName, scripts = {} } = packages.get( packagePath );
-
-		if ( buildScript in scripts ) {
-			logInfo( `* Processing "${ chalk.underline( packageName ) }"...`, { indent: 1, startWithNewLine: true } );
-
-			process.chdir( packagePath );
-
-			exec( `yarn run ${ buildScript }` );
-		}
-	} );
-}
-
-/**
- * @param {String} message
- */
-function logProcess( message ) {
-	console.log( '\n📍 ' + chalk.cyan( message ) );
-}
-
-/**
- * @param {String} message
- * @param {Object} options
- * @param {Number} [options.indent=0]
- * @param {Boolean} [options.startWithNewLine=false]
- */
-function logInfo( message, { indent = 0, startWithNewLine = false } = {} ) {
-	console.log( ( startWithNewLine ? '\n' : '' ) + ' '.repeat( indent * 3 ) + message );
-}
-
-/**
- * @param {String} command
- * @returns {String}
- */
-function exec( command ) {
-	return tools.shExec( command );
-}
-
-/**
- * @typedef {Object} PackageJson
- * @property {String} version
- * @property {String} name
- */