@ckeditor/ckeditor5-dev-release-tools 61.0.0 → 61.1.0

package/lib/index.js

@@ -32,3 +32,4 @@ export { default as executeInParallel } from './utils/executeinparallel.js';
 export { default as validateRepositoryToRelease } from './utils/validaterepositorytorelease.js';
 export { default as getNpmTagFromVersion } from './utils/getnpmtagfromversion.js';
 export { default as provideToken } from './utils/providetoken.js';
+export { default as validateGithubToken } from './utils/validategithubtoken.js';

package/lib/tasks/updatedependencies.js

@@ -26,6 +26,7 @@ const { normalizeTrim } = upath;
  * for a dependency. It receives a package name as an argument and should return a boolean value.
  * @param {UpdateDependenciesPackagesDirectoryFilter|null} [options.packagesDirectoryFilter=null] An optional callback allowing
  * filtering out directories/packages that should not be touched by the task.
+ * @param {boolean} [options.includeCwd=true] Whether to update dependencies in the package located directly in `options.cwd`.
  * @param {string} [options.packagesDirectory] Relative path to a location of packages to update their dependencies. If not specified,
  * only the root package is checked.
  * @param {string} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
@@ -37,6 +38,7 @@ export default async function updateDependencies( options ) {
 		packagesDirectory,
 		shouldUpdateVersionCallback,
 		packagesDirectoryFilter = null,
+		includeCwd = true,
 		cwd = process.cwd()
 	} = options;
 
@@ -45,7 +47,7 @@ export default async function updateDependencies( options ) {
 		packagesDirectory ? normalizeTrim( packagesDirectory ) : null,
 		{
 			includePackageJson: true,
-			includeCwd: true,
+			includeCwd,
 			packagesDirectoryFilter
 		}
 	);

package/lib/utils/providetoken.js

@@ -4,23 +4,32 @@
  */
 
 import inquirer from 'inquirer';
+import validateGithubToken from './validategithubtoken.js';
 
 /**
  * Asks a user for providing the GitHub token.
  *
+ * @param {object} [options]
+ * @param {string} [options.cwd=process.cwd()] Current working directory from which the repository will be resolved.
  * @returns {Promise.<string>}
  */
-export default async function provideToken() {
+export default async function provideToken( { cwd = process.cwd() } = {} ) {
 	const tokenQuestion = {
 		type: 'password',
 		name: 'token',
 		message: 'Provide the GitHub token:',
-		validate( input ) {
-			return input.length === 40 ? true : 'Please provide a valid token.';
+		async validate( input ) {
+			try {
+				await validateGithubToken( input, { cwd } );
+
+				return true;
+			} catch ( error ) {
+				return error.message;
+			}
 		}
 	};
 
 	const { token } = await inquirer.prompt( [ tokenQuestion ] );
 
-	return token;
+	return token.trim();
 }

package/lib/utils/validategithubtoken.js

@@ -0,0 +1,72 @@
+/**
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import { Octokit } from '@octokit/rest';
+import { workspaces } from '@ckeditor/ckeditor5-dev-utils';
+
+const VALIDATION_TAG_NAME = 'ckeditor5-dev-release-tools-token-validation';
+
+/**
+ * Verifies that a GitHub token can create a release in the current repository.
+ *
+ * @param {string} token Token used to authenticate with GitHub.
+ * @param {object} options
+ * @param {string} options.cwd=process.cwd() Current working directory from which the repository will be resolved.
+ * @returns {Promise.<string>} The normalized token.
+ */
+export default async function validateGithubToken( token, { cwd } ) {
+	const normalizedToken = token.trim();
+
+	if ( !normalizedToken ) {
+		throw new Error( 'The token cannot be empty.' );
+	}
+
+	const repositoryUrl = workspaces.getRepositoryUrl( cwd );
+	const [ repositoryName, repositoryOwner ] = repositoryUrl.split( '/' ).reverse();
+	const repository = `${ repositoryOwner }/${ repositoryName }`;
+	const github = new Octokit( { auth: normalizedToken } );
+
+	let repositoryDetails;
+
+	try {
+		repositoryDetails = await github.repos.get( {
+			owner: repositoryOwner,
+			repo: repositoryName
+		} );
+	} catch ( error ) {
+		throw createValidationError( error, repository );
+	}
+
+	try {
+		// This endpoint only computes and returns proposed release notes. It does not persist a release, tag, or any other data.
+		// See: https://docs.github.com/en/rest/releases/releases#generate-release-notes-content-for-a-release
+		await github.repos.generateReleaseNotes( {
+			owner: repositoryOwner,
+			repo: repositoryName,
+			tag_name: VALIDATION_TAG_NAME,
+			target_commitish: repositoryDetails.data.default_branch
+		} );
+	} catch ( error ) {
+		throw createValidationError( error, repository );
+	}
+
+	return normalizedToken;
+}
+
+/**
+ * @param {Error & { status?: number, response?: { data?: { message?: string } } }} error
+ * @param {string} repository
+ * @returns {Error}
+ */
+function createValidationError( error, repository ) {
+	const githubMessage = error.response?.data?.message || error.message;
+
+	if ( error.status ) {
+		return new Error( `GitHub API request for the "${ repository }" repository failed ` +
+			`with HTTP ${ error.status }: ${ githubMessage }` );
+	}
+
+	return new Error( `Could not verify the token for the "${ repository }" repository: ${ githubMessage }` );
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "61.0.0",
+  "version": "61.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": "^61.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^61.1.0",
     "@octokit/rest": "^22.0.1",
     "cli-columns": "^4.0.0",
     "glob": "^13.0.6",