@ckeditor/ckeditor5-dev-release-tools 55.0.0-alpha.5 → 55.1.0

package/lib/tasks/creategithubrelease.js

@@ -14,6 +14,7 @@ import getNpmTagFromVersion from '../utils/getnpmtagfromversion.js';
  * @param {string} options.token Token used to authenticate with GitHub.
  * @param {string} options.version Name of tag connected with the release.
  * @param {string} options.description Description of the release.
+ * @param {boolean} [options.isLatest=true] Whether the release should be marked as the latest.
  * @param {string} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @returns {Promise.<string>}
  */
@@ -22,6 +23,7 @@ export default async function createGithubRelease( options ) {
 		token,
 		version,
 		description,
+		isLatest = true,
 		cwd = process.cwd()
 	} = options;
 
@@ -39,7 +41,8 @@ export default async function createGithubRelease( options ) {
 			owner: repositoryOwner,
 			repo: repositoryName,
 			body: description,
-			prerelease: getNpmTagFromVersion( version ) !== 'latest'
+			prerelease: getNpmTagFromVersion( version ) !== 'latest',
+			make_latest: String( isLatest )
 		} );
 	}
 

package/lib/tasks/publishpackages.js

@@ -23,7 +23,7 @@ import { workspaces, npm } from '@ckeditor/ckeditor5-dev-utils';
  * - A package directory must contain `package.json` file.
  * - All files defined in the `optionalEntryPointPackages` option must exist in a package directory.
  * - An npm tag (dist-tag) must match the tag calculated from the package version.
- *   A stable release can be also published as `next` or `staging.
+ *   A stable release can be also published as `next`, `staging`, or `latest-v{major}`.
  *
  * When the validation for each package passes, packages are published on npm. Optional callback is called for confirmation whether to
  * continue.
@@ -37,6 +37,7 @@ import { workspaces, npm } from '@ckeditor/ckeditor5-dev-utils';
  * @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 {boolean} [options.disallowLatestNpmTag=false] Whether to disallow publishing packages using the `latest` 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
  * it is allowed not to match any file. The `options.optionalEntries` object may also contain the `default` key, which is used for all
@@ -59,6 +60,7 @@ export default async function publishPackages( options ) {
 		listrTask,
 		signal = null,
 		npmTag = 'staging',
+		disallowLatestNpmTag = false,
 		optionalEntries = null,
 		confirmationCallback = null,
 		requireEntryPoint = false,
@@ -94,7 +96,7 @@ export default async function publishPackages( options ) {
 
 	await assertPackages( packagesToProcess, { requireEntryPoint, optionalEntryPointPackages } );
 	await assertFilesToPublish( packagesToProcess, optionalEntries );
-	await assertNpmTag( packagesToProcess, npmTag );
+	await assertNpmTag( packagesToProcess, npmTag, { disallowLatestNpmTag } );
 
 	const shouldPublishPackages = confirmationCallback ? await confirmationCallback() : true;
 

package/lib/tasks/reassignnpmtags.js

@@ -15,7 +15,8 @@ import { exec } from 'node:child_process';
 const execPromise = promisify( exec );
 
 /**
- * Used to switch the tags from `staging` to `latest` for specified array of packages.
+ * Used to assign a dist-tag to a specified version for all packages from the release set.
+ * It supports built-in tags (e.g. `latest`, `staging`, `next`) and custom tags (e.g. `latest-v{X}`).
  * Each operation will be retried up to 3 times in case of failure.
  *
  * @param {object} options

package/lib/utils/assertnpmtag.js

@@ -5,6 +5,7 @@
 
 import fs from 'node:fs/promises';
 import upath from 'upath';
+import semver from 'semver';
 import getNpmTagFromVersion from './getnpmtagfromversion.js';
 
 const ALLOWED_NPM_LATEST_TAGS = [
@@ -14,14 +15,22 @@ const ALLOWED_NPM_LATEST_TAGS = [
 
 /**
  * Checks if the npm tag matches the tag calculated from the package version. Verification takes place for all packages.
+ * Stable versions can additionally use `latest-v{major}` where `{major}` matches the version major.
  *
  * @param {Array.<string>} packagePaths
  * @param {string} npmTag
+ * @param {object} [options={}]
+ * @param {boolean} [options.disallowLatestNpmTag=false] Whether to disallow publishing packages using the `latest` npm distribution tag.
  * @returns {Promise}
  */
-export default async function assertNpmTag( packagePaths, npmTag ) {
+export default async function assertNpmTag( packagePaths, npmTag, options = {} ) {
+	const { disallowLatestNpmTag = false } = options;
 	const errors = [];
 
+	if ( disallowLatestNpmTag && npmTag === 'latest' ) {
+		throw new Error( 'Publishing with the npm tag "latest" is disallowed.' );
+	}
+
 	for ( const packagePath of packagePaths ) {
 		const path = upath.join( packagePath, 'package.json' );
 		const file = await fs.readFile( path, 'utf-8' );
@@ -32,8 +41,14 @@ export default async function assertNpmTag( packagePaths, npmTag ) {
 			continue;
 		}
 
-		if ( versionTag === 'latest' && ALLOWED_NPM_LATEST_TAGS.includes( npmTag ) ) {
-			continue;
+		if ( versionTag === 'latest' ) {
+			if ( ALLOWED_NPM_LATEST_TAGS.includes( npmTag ) ) {
+				continue;
+			}
+
+			if ( isValidLatestMajorTag( packageJson.version, npmTag ) ) {
+				continue;
+			}
 		}
 
 		errors.push( `The version tag "${ versionTag }" from "${ packageJson.name }" package does not match the npm tag "${ npmTag }".` );
@@ -43,3 +58,13 @@ export default async function assertNpmTag( packagePaths, npmTag ) {
 		throw new Error( errors.join( '\n' ) );
 	}
 }
+
+function isValidLatestMajorTag( version, npmTag ) {
+	const match = npmTag.match( /^latest-v(\d+)$/ );
+
+	if ( !match ) {
+		return false;
+	}
+
+	return semver.major( version ) === Number( match[ 1 ] );
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "55.0.0-alpha.5",
+  "version": "55.1.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -22,7 +22,7 @@
     "lib"
   ],
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^55.0.0-alpha.5",
+    "@ckeditor/ckeditor5-dev-utils": "^55.1.0",
     "@octokit/rest": "^22.0.0",
     "cli-columns": "^4.0.0",
     "glob": "^13.0.0",