@ckeditor/ckeditor5-dev-release-tools 46.0.7 → 46.1.0

package/lib/tasks/commitandtag.js

@@ -17,9 +17,17 @@ const { toUnix } = upath;
  * @param {Array.<string>} options.files Array of glob patterns for files to be added to the release commit.
  * @param {string} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @param {boolean} [options.skipCi=true] Whether to add the "[skip ci]" suffix to the commit message.
+ * @param {boolean} [options.dryRun=false] When enabled, the function creates a commit to allow executing a pre-commit hook,
+ * then removes it using the `git reset` command.
  * @returns {Promise}
  */
-export default async function commitAndTag( { version, files, cwd = process.cwd(), skipCi = true } ) {
+export default async function commitAndTag( {
+	version,
+	files,
+	cwd = process.cwd(),
+	skipCi = true,
+	dryRun = false
+} ) {
 	const normalizedCwd = toUnix( cwd );
 	const filePathsToAdd = await glob( files, { cwd: normalizedCwd, absolute: true, nodir: true } );
 
@@ -34,11 +42,18 @@ export default async function commitAndTag( { version, files, cwd = process.cwd(
 	const { all: availableTags } = await git.tags();
 	const tagForVersion = availableTags.find( tag => tag.endsWith( version ) );
 
-	// Do not commit and create tags if a tag is already taken. It might happen when a release job is restarted.
-	if ( tagForVersion ) {
-		return;
-	}
+	const makeCommit = () => {
+		return git.commit( `Release: v${ version }.${ skipCi ? ' [skip ci]' : '' }`, filePathsToAdd );
+	};
 
-	await git.commit( `Release: v${ version }.${ skipCi ? ' [skip ci]' : '' }`, filePathsToAdd );
-	await git.addTag( `v${ version }` );
+	if ( dryRun ) {
+		const lastCommit = await git.log( [ '-1' ] );
+
+		await makeCommit();
+		await git.reset( [ lastCommit.latest.hash ] );
+	} else if ( !tagForVersion ) {
+		// Commit and create a tag if it does not exist yet. It might happen when a release job is restarted.
+		await makeCommit();
+		await git.addAnnotatedTag( `v${ version }`, `Release: v${ version }.` );
+	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "46.0.7",
+  "version": "46.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": "^46.0.7",
+    "@ckeditor/ckeditor5-dev-utils": "^46.1.0",
     "@octokit/rest": "^21.0.0",
     "chalk": "^5.0.0",
     "cli-columns": "^4.0.0",