@ckeditor/ckeditor5-dev-release-tools 36.0.0 → 37.0.0

package/lib/tasks/preparepackages.js

@@ -51,6 +51,7 @@ const PACKAGE_JSON_FIELDS = [
  * @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 ) {
@@ -58,6 +59,7 @@ module.exports = async function preparePackages( options ) {
 	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...' );
@@ -91,7 +93,7 @@ module.exports = async function preparePackages( options ) {
 	}
 
 	logProcess( 'Preparing packages...' );
-	await preparePackagesToBeReleased( packages );
+	await preparePackagesToBeReleased( packages, npmScriptsToRemove );
 
 	// Secure the entire release directory.
 	logProcess( 'Securing the code...' );
@@ -139,9 +141,10 @@ function filterOutPackagesWithoutChanges( packages, ckeditor5Version ) {
  *   * 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 ) {
+function preparePackagesToBeReleased( packages, npmScriptsToRemove ) {
 	return executeOnPackages( packages.keys(), async packagePath => {
 		const { name: packageName } = packages.get( packagePath );
 
@@ -167,6 +170,12 @@ function preparePackagesToBeReleased( packages ) {
 				}
 			}
 
+			if ( 'scripts' in packageJson ) {
+				for ( const npmScript of npmScriptsToRemove ) {
+					delete packageJson.scripts[ npmScript ];
+				}
+			}
+
 			if ( !main ) {
 				return packageJson;
 			}

package/lib/tasks/releasesubrepositories.js

@@ -284,7 +284,7 @@ module.exports = async function releaseSubRepositories( options ) {
 		const packageJson = getPackageJson( options.cwd );
 		logProcess( 'Verifying the npm tag...' );
 
-		const [ versionTag ] = semver.prerelease( packageJson.version ) || [ 'latest' ];
+		const versionTag = getVersionTag( packageJson.version );
 
 		if ( versionTag !== npmTag ) {
 			log.warning( '⚠️  The version tag is different from the npm tag.' );
@@ -427,7 +427,7 @@ module.exports = async function releaseSubRepositories( options ) {
 					throw new Error( MISSING_FILES_MESSAGE );
 				}
 
-				const npmVersion = getVersionFromNpm( packageJson.name );
+				const npmVersion = getVersionFromNpm( packageJson.name, npmTag );
 
 				logDryRun( `Versions: package.json: "${ releaseDetails.version }", npm: "${ npmVersion || 'initial release' }".` );
 
@@ -545,9 +545,9 @@ module.exports = async function releaseSubRepositories( options ) {
 		// Checks whether specified `packageName` has been published on npm.
 		// If so, returns its version. Otherwise returns `null` which means that
 		// this package will be published for the first time.
-		function getVersionFromNpm( packageName ) {
+		function getVersionFromNpm( packageName, npmTag ) {
 			try {
-				return exec( `npm show ${ packageName } version` ).trim();
+				return exec( `npm show ${ packageName }@${ npmTag } version` ).trim();
 			} catch ( err ) {
 				if ( err.message.match( /npm ERR! 404/ ) ) {
 					return null;
@@ -869,11 +869,14 @@ module.exports = async function releaseSubRepositories( options ) {
 			return Promise.resolve();
 		}
 
+		const versionTag = getVersionTag( releaseDetails.version );
+
 		const githubReleaseOptions = {
 			repositoryOwner: releaseDetails.repositoryOwner,
 			repositoryName: releaseDetails.repositoryName,
 			version: `v${ releaseDetails.version }`,
-			description: releaseDetails.changes
+			description: releaseDetails.changes,
+			isPrerelease: versionTag !== 'latest'
 		};
 
 		return createGithubRelease( releaseOptions.token, githubReleaseOptions )
@@ -894,6 +897,21 @@ module.exports = async function releaseSubRepositories( options ) {
 			);
 	}
 
+	/**
+	 * Returns the version tag for the package.
+	 *
+	 * For the official release, returns the "latest" tag. For a non-official release (pre-release), returns the version tag extracted from
+	 * the package version.
+	 *
+	 * @param {String} version Version of the package to be released.
+	 * @returns {String}
+	 */
+	function getVersionTag( version ) {
+		const [ versionTag ] = semver.prerelease( version ) || [ 'latest' ];
+
+		return versionTag;
+	}
+
 	// Removes all temporary directories that were created for publishing the custom repository.
 	//
 	// @returns {Promise}

package/lib/tasks/updateckeditor5dependencies.js

@@ -14,7 +14,7 @@ const glob = require( 'glob' );
 const { diffLines: diff } = require( 'diff' );
 
 // The pattern defines CKEditor 5 dependencies.
-const CKEDITOR5_DEPENDENCY_PATTERN = /^@ckeditor\/ckeditor5-(.*)|^ckeditor5$/;
+const CKEDITOR5_DEPENDENCY_PATTERN = /^@ckeditor\/ckeditor5-(.*)|^ckeditor5(-collaboration)?$/;
 
 // Packages that match the CKEditor 5 pattern but should not be updated because they aren't a dependency of the project.
 const PATTERNS_TO_SKIP = [

package/lib/utils/creategithubrelease.js

@@ -16,6 +16,7 @@ const { Octokit } = require( '@octokit/rest' );
  * @param {String} options.repositoryName Repository name.
  * @param {String} options.version Name of tag connected with the release.
  * @param {String} options.description Description of the release.
+ * @param {Boolean} options.isPrerelease Indicates whether the release is a pre-release.
  * @returns {Promise}
  */
 module.exports = function createGithubRelease( token, options ) {
@@ -28,7 +29,8 @@ module.exports = function createGithubRelease( token, options ) {
 		owner: options.repositoryOwner,
 		repo: options.repositoryName,
 		tag_name: options.version,
-		body: options.description
+		body: options.description,
+		prerelease: options.isPrerelease
 	};
 
 	return github.repos.createRelease( releaseParams );

package/package.json

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