@ckeditor/ckeditor5-dev-release-tools 44.0.0-alpha.0 → 44.0.0-alpha.2

package/lib/tasks/commitandtag.js

@@ -38,7 +38,11 @@ export default async function commitAndTag( { version, files, cwd = process.cwd(
 		await tools.shExec( `git add ${ shellEscape( [ filePath ] ) }`, shExecOptions );
 	}
 
-	const escapedVersion = shellEscape( [ version ] );
-	await tools.shExec( `git commit --message "Release: v${ escapedVersion }." --no-verify`, shExecOptions );
-	await tools.shExec( `git tag v${ escapedVersion }`, shExecOptions );
+	const escapedVersion = {
+		commit: shellEscape( [ `Release: v${ version }.` ] ),
+		tag: shellEscape( [ `v${ version }` ] )
+	};
+
+	await tools.shExec( `git commit --message ${ escapedVersion.commit } --no-verify`, shExecOptions );
+	await tools.shExec( `git tag ${ escapedVersion.tag }`, shExecOptions );
 }

package/lib/tasks/generatechangelogformonorepository.js

@@ -53,6 +53,8 @@ const noteInfo = `[ℹ️](${ VERSIONING_POLICY_URL }#major-and-minor-breaking-c
  *
  * @param {String} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
  *
+ * @param {String} [options.mainBranch='master'] A name of the main branch in the repository.
+ *
  * @param {Array.<ExternalRepository>} [options.externalRepositories=[]] An array of object with additional repositories
  * that the function takes into consideration while gathering commits. It assumes that those directories are also mono repositories.
  *
@@ -85,6 +87,7 @@ export default async function generateChangelogForMonoRepository( options ) {
 		cwd: options.cwd,
 		from: options.from ? options.from : 'v' + rootPkgJson.version,
 		releaseBranch: options.releaseBranch || 'master',
+		mainBranch: options.mainBranch || 'master',
 		externalRepositories: options.externalRepositories || []
 	};
 
@@ -225,7 +228,8 @@ export default async function generateChangelogForMonoRepository( options ) {
 
 		const commitOptions = {
 			from: options.from,
-			releaseBranch: options.releaseBranch
+			releaseBranch: options.releaseBranch,
+			mainBranch: options.mainBranch
 		};
 
 		let promise = getCommits( transformCommit, commitOptions )
@@ -415,9 +419,9 @@ export default async function generateChangelogForMonoRepository( options ) {
 			date: options.formatDate ? options.formatDate( new Date() ) : getFormattedDate()
 		};
 
-		const writerOptions = getWriterOptions( {
+		const writerOptions = getWriterOptions( commit => {
 			// We do not allow modifying the commit hash value by the generator itself.
-			hash: hash => hash
+			return commit;
 		} );
 
 		writerOptions.commitsSort = sortFunctionFactory( 'rawScope' );

package/lib/tasks/generatechangelogforsinglepackage.js

@@ -36,6 +36,8 @@ const SKIP_GENERATE_CHANGELOG = 'Typed "skip" as a new version. Aborting.';
  *
  * @param {String} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
  *
+ * @param {String} [options.mainBranch='master'] A name of the main branch in the repository.
+ *
  * @param {FormatDateCallback} [options.formatDate] A callback allowing defining a custom format of the date inserted into the changelog.
  * If not specified, the default date matches the `YYYY-MM-DD` pattern.
  *
@@ -53,7 +55,8 @@ export default async function generateChangelogForSinglePackage( options = {} )
 
 	const commitOptions = {
 		from: options.from ? options.from : 'v' + pkgJson.version,
-		releaseBranch: options.releaseBranch
+		releaseBranch: options.releaseBranch || 'master',
+		mainBranch: options.mainBranch || 'master'
 	};
 
 	// Initial release.
@@ -110,9 +113,9 @@ export default async function generateChangelogForSinglePackage( options = {} )
 				date: options.formatDate ? options.formatDate( new Date() ) : getFormattedDate()
 			};
 
-			const writerOptions = getWriterOptions( {
+			const writerOptions = getWriterOptions( commit => {
 				// We do not allow modifying the commit hash value by the generator itself.
-				hash: hash => hash
+				return commit;
 			} );
 
 			const publicCommits = [ ...allCommits ]

package/lib/utils/generatechangelog.js

@@ -5,7 +5,7 @@
 
 import { Readable } from 'stream';
 import { stream } from '@ckeditor/ckeditor5-dev-utils';
-import conventionalChangelogWriter from 'conventional-changelog-writer';
+import { writeChangelogStream } from 'conventional-changelog-writer';
 
 const UPDATED_TRANSLATION_COMMIT = '* Updated translations.';
 
@@ -49,7 +49,7 @@ export default function generateChangelog( commits, context, options ) {
 
 	return new Promise( ( resolve, reject ) => {
 		commitStream
-			.pipe( conventionalChangelogWriter( context, options ) )
+			.pipe( writeChangelogStream( context, options ) )
 			.pipe( stream.noop( changes => {
 				changes = mergeUpdateTranslationsCommits( changes.toString(), {
 					skipCommitsLink: context.skipCommitsLink

package/lib/utils/getcommits.js

@@ -3,9 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-import conventionalCommitsParser from 'conventional-commits-parser';
-import conventionalCommitsFilter from 'conventional-commits-filter';
-import gitRawCommits from 'git-raw-commits';
+import { parseCommitsStream } from 'conventional-commits-parser';
+import { filterRevertedCommitsSync } from 'conventional-commits-filter';
+import { getRawCommitsStream } from 'git-raw-commits';
 import concat from 'concat-stream';
 import parserOptions from './parseroptions.js';
 import { tools } from '@ckeditor/ckeditor5-dev-utils';
@@ -45,7 +45,7 @@ export default function getCommits( transformCommit, options = {} ) {
 			// 1. Commits from the last release and to the point where the release branch was created (the merge-base commit).
 			findCommits( { from: options.from, to: baseCommit } ),
 			// 2. Commits from the merge-base commit to HEAD.
-			findCommits( { from: baseCommit } )
+			findCommits( { from: baseCommit, to: 'HEAD' } )
 		];
 
 		return Promise.all( commitPromises )
@@ -60,7 +60,7 @@ export default function getCommits( transformCommit, options = {} ) {
 		} );
 
 		return new Promise( ( resolve, reject ) => {
-			const stream = gitRawCommits( gitRawCommitsOpts )
+			const stream = getRawCommitsStream( gitRawCommitsOpts )
 				.on( 'error', err => {
 					/* istanbul ignore else */
 					if ( err.message.match( /'HEAD': unknown/ ) ) {
@@ -74,9 +74,9 @@ export default function getCommits( transformCommit, options = {} ) {
 					}
 				} );
 
-			stream.pipe( conventionalCommitsParser( parserOptions ) )
+			stream.pipe( parseCommitsStream( parserOptions ) )
 				.pipe( concat( data => {
-					const commits = conventionalCommitsFilter( data )
+					const commits = [ ...filterRevertedCommitsSync( data ) ]
 						.map( commit => transformCommit( commit ) )
 						.reduce( ( allCommits, commit ) => {
 							if ( Array.isArray( commit ) ) {

package/lib/utils/getpackagespaths.js

@@ -4,7 +4,7 @@
  */
 
 import path from 'path';
-import minimatch from 'minimatch';
+import { minimatch } from 'minimatch';
 import { tools } from '@ckeditor/ckeditor5-dev-utils';
 import getPackageJson from './getpackagejson.js';
 

package/lib/utils/getwriteroptions.js

@@ -14,7 +14,7 @@ const __dirname = path.dirname( __filename );
 const templatePath = path.join( __dirname, '..', 'templates' );
 
 /**
- * @param {Function|Object} transform
+ * @param {WriterOptionsTransformCallback} transform
  * @returns {Object}
  */
 export default function getWriterOptions( transform ) {
@@ -34,3 +34,9 @@ export default function getWriterOptions( transform ) {
 function sortFunction( a, b ) {
 	return getTypeOrder( a.title ) - getTypeOrder( b.title );
 }
+
+/**
+ * @callback WriterOptionsTransformCallback
+ * @param {Commit}
+ * @returns {Commit}
+ */

package/lib/utils/transformcommitfactory.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-import lodash from 'lodash';
+import { cloneDeepWith } from 'lodash-es';
 import * as utils from './transformcommitutils.js';
 import getChangedFilesForCommit from './getchangedfilesforcommit.js';
 
-const { cloneDeepWith } = lodash;
-
 // Squash commit follows the pattern: "A pull request title (#{number})".
 const SQUASH_COMMIT_REGEXP = /^[\W\w]+ \(#\d+\)$/;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "44.0.0-alpha.0",
+  "version": "44.0.0-alpha.2",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -22,23 +22,23 @@
     "lib"
   ],
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^44.0.0-alpha.0",
-    "@octokit/rest": "^19.0.0",
-    "chalk": "^4.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^44.0.0-alpha.2",
+    "@octokit/rest": "^21.0.0",
+    "chalk": "^5.0.0",
     "cli-columns": "^4.0.0",
     "compare-func": "^2.0.0",
     "concat-stream": "^2.0.0",
-    "conventional-changelog-writer": "^6.0.0",
-    "conventional-commits-filter": "^3.0.0",
-    "conventional-commits-parser": "^4.0.0",
-    "date-fns": "^2.30.0",
-    "fs-extra": "^11.2.0",
-    "git-raw-commits": "^3.0.0",
-    "glob": "^10.2.5",
-    "inquirer": "^7.1.0",
-    "lodash": "^4.17.15",
-    "minimatch": "^3.0.4",
-    "semver": "^7.5.3",
+    "conventional-changelog-writer": "^8.0.0",
+    "conventional-commits-filter": "^5.0.0",
+    "conventional-commits-parser": "^6.0.0",
+    "date-fns": "^4.0.0",
+    "fs-extra": "^11.0.0",
+    "git-raw-commits": "^5.0.0",
+    "glob": "^10.0.0",
+    "inquirer": "^11.0.0",
+    "lodash-es": "^4.17.21",
+    "minimatch": "^9.0.0",
+    "semver": "^7.6.3",
     "shell-escape": "^0.2.0",
     "upath": "^2.0.1"
   }