@ckeditor/ckeditor5-dev-release-tools 51.1.0 → 52.0.0

package/lib/tasks/generatechangelogforsinglepackage.js

@@ -1,211 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-import fs from 'fs';
-import { tools, logger, workspaces } from '@ckeditor/ckeditor5-dev-utils';
-import chalk from 'chalk';
-import semver from 'semver';
-import displayCommits from '../utils/displaycommits.js';
-import generateChangelog from '../utils/generatechangelog.js';
-import getNewVersionType from '../utils/getnewversiontype.js';
-import getCommits from '../utils/getcommits.js';
-import getWriterOptions from '../utils/getwriteroptions.js';
-import transformCommitFactory from '../utils/transformcommitfactory.js';
-import getFormattedDate from '../utils/getformatteddate.js';
-import saveChangelog from '../utils/savechangelog.js';
-import getChangelog from '../utils/getchangelog.js';
-import provideVersion from '../utils/provideversion.js';
-import { CHANGELOG_FILE, CHANGELOG_HEADER, CLI_INDENT_SIZE } from '../utils/constants.js';
-
-const SKIP_GENERATE_CHANGELOG = 'Typed "skip" as a new version. Aborting.';
-
-/**
- * Generates the changelog based on commit messages in a package that is located under current work directory (cwd).
- *
- * If the package does not have any commit, the user has to confirm whether the changelog should be generated.
- *
- * @param {object} [options={}] Additional options.
- *
- * @param {boolean} [options.skipLinks=false] If set on true, links to release or commits will be omitted.
- *
- * @param {string} [options.from] A commit or tag name that will be the first param of the range of commits to collect.
- *
- * @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.
- *
- * @returns {Promise}
- */
-export default async function generateChangelogForSinglePackage( options = {} ) {
-	const log = logger();
-	const pkgJson = workspaces.getPackageJson();
-
-	logProcess( chalk.bold( `Generating changelog for "${ chalk.underline( pkgJson.name ) }"...` ) );
-
-	const transformCommit = transformCommitFactory();
-
-	logProcess( 'Collecting all commits since the last release...' );
-
-	const commitOptions = {
-		from: options.from ? options.from : 'v' + pkgJson.version,
-		releaseBranch: options.releaseBranch || 'master',
-		mainBranch: options.mainBranch || 'master'
-	};
-
-	// Initial release.
-	if ( semver.eq( pkgJson.version, '0.0.1' ) ) {
-		commitOptions.from = null;
-	}
-
-	// Collection of all entries (real commits + additional "fake" commits extracted from descriptions).
-	let allCommits;
-
-	// A new version inserted into the changelog.
-	let newVersion;
-
-	return getCommits( transformCommit, commitOptions )
-		.then( commits => {
-			allCommits = commits;
-
-			logInfo( `Found ${ commits.length } entries to parse.`, { indentLevel: 1 } );
-		} )
-		.then( () => {
-			logProcess( 'Preparing new version for the package...' );
-
-			displayCommits( allCommits, { indentLevel: 1 } );
-
-			return provideVersion( {
-				packageName: pkgJson.name,
-				version: pkgJson.version,
-				indentLevel: 1,
-				releaseTypeOrNewVersion: getNewVersionType( allCommits )
-			} );
-		} )
-		.then( version => {
-			if ( version === 'skip' ) {
-				throw new Error( SKIP_GENERATE_CHANGELOG );
-			}
-
-			const isInternalRelease = version === 'internal';
-
-			if ( version === 'internal' ) {
-				version = semver.inc( pkgJson.version, 'patch' );
-			}
-
-			newVersion = version;
-
-			logProcess( 'Generating the changelog...' );
-
-			const writerContext = {
-				version,
-				commit: 'commit',
-				repoUrl: workspaces.getRepositoryUrl(),
-				currentTag: 'v' + version,
-				previousTag: options.from ? options.from : 'v' + pkgJson.version,
-				isPatch: semver.diff( version, pkgJson.version ) === 'patch',
-				isInternalRelease,
-				skipCommitsLink: Boolean( options.skipLinks ),
-				skipCompareLink: Boolean( options.skipLinks ),
-				date: options.formatDate ? options.formatDate( new Date() ) : getFormattedDate()
-			};
-
-			const writerOptions = getWriterOptions( commit => {
-				// We do not allow modifying the commit hash value by the generator itself.
-				return commit;
-			} );
-
-			const publicCommits = [ ...allCommits ]
-				.filter( commit => commit.isPublicCommit )
-				.map( commit => {
-					commit.scope = null;
-					commit.notes = commit.notes.map( note => {
-						note.scope = null;
-
-						return note;
-					} );
-
-					return commit;
-				} );
-
-			return generateChangelog( publicCommits, writerContext, writerOptions )
-				.then( changes => {
-					logInfo( 'Changes based on commits have been generated.', { indentLevel: 1 } );
-
-					return Promise.resolve( changes );
-				} );
-		} )
-		.then( changesFromCommits => {
-			logProcess( 'Saving changelog...' );
-
-			if ( !fs.existsSync( CHANGELOG_FILE ) ) {
-				logInfo( 'Changelog file does not exist. Creating...', { isWarning: true, indentLevel: 1 } );
-
-				saveChangelog( CHANGELOG_HEADER );
-			}
-
-			let currentChangelog = getChangelog();
-
-			// Remove header from current changelog.
-			currentChangelog = currentChangelog.replace( CHANGELOG_HEADER, '' );
-
-			// Concat header, new and current changelog.
-			let newChangelog = CHANGELOG_HEADER + changesFromCommits + currentChangelog.trim();
-			newChangelog = newChangelog.trim() + '\n';
-
-			// Save the changelog.
-			saveChangelog( newChangelog );
-
-			tools.shExec( `git add ${ CHANGELOG_FILE }`, { verbosity: 'error' } );
-			tools.shExec( 'git commit -m "Docs: Changelog. [skip ci]"', { verbosity: 'error' } );
-
-			logInfo( 'Saved.', { indentLevel: 1 } );
-		} )
-		.then( () => {
-			logInfo( `Changelog for "${ chalk.underline( pkgJson.name ) }" (v${ newVersion }) has been generated.`, { indentLevel: 1 } );
-		} )
-		.catch( err => {
-			if ( err.message === SKIP_GENERATE_CHANGELOG ) {
-				logInfo( `Skipping generating the changelog for "${ chalk.underline( pkgJson.name ) }".`, {
-					indentLevel: 1,
-					isWarning: true,
-					startWithNewLine: true
-				} );
-
-				return;
-			}
-
-			throw err;
-		} );
-
-	function logProcess( message ) {
-		log.info( '\n📍 ' + chalk.cyan( message ) );
-	}
-
-	/**
-	 * @param {string} message
-	 * @param {object} [options={}]
-	 * @param {number} [options.indentLevel=0]
-	 * @param {boolean} [options.startWithNewLine=false] Whether to append a new line before the message.
-	 * @param {boolean} [options.isWarning=false] Whether to use `warning` method instead of `log`.
-	 */
-	function logInfo( message, options = {} ) {
-		const indentLevel = options.indentLevel || 0;
-		const startWithNewLine = options.startWithNewLine || false;
-		const method = options.isWarning ? 'warning' : 'info';
-
-		log[ method ]( `${ startWithNewLine ? '\n' : '' }${ ' '.repeat( indentLevel * CLI_INDENT_SIZE ) }` + message );
-	}
-}
-
-/**
- * @callback FormatDateCallback
- *
- * @param {Date} now The current date.
- *
- * @returns {string} The formatted date inserted into the changelog.
- */

package/lib/templates/commit.hbs

@@ -1,29 +0,0 @@
-* {{#if scope}}**{{~scope.[0]}}**: {{/if}}{{subject}}
-
-{{~#unless @root.skipCommitsLink }}
-    {{~#unless skipCommitsLink }}
-        {{~!-- commit link --}} {{#if @root.linkReferences~}}
-          ([commit](
-          {{~#if @root.repository}}
-            {{~#if @root.host}}
-              {{~@root.host}}/
-            {{~/if}}
-            {{~#if @root.owner}}
-              {{~@root.owner}}/
-            {{~/if}}
-            {{~@root.repository}}
-          {{~else}}
-            {{~@root.repoUrl}}
-          {{~/if}}/
-          {{~@root.commit}}/{{hash}}))
-        {{~else}}
-          {{~hash}}
-        {{~/if}}
-    {{/unless}}
-{{/unless}}
-{{#if body}}
-
-
-{{body}}
-{{~/if}}
-

package/lib/templates/footer.hbs

@@ -1,10 +0,0 @@
-{{#if noteGroups}}
-{{#each noteGroups}}
-### {{title}}
-
-{{#each notes}}
-* {{#if scope}}**{{~scope.[0]}}**: {{/if}}{{text}}
-{{/each}}
-
-{{/each}}
-{{/if}}

package/lib/templates/header.hbs

@@ -1,23 +0,0 @@
-## {{#unless @root.skipCompareLink~}}
-	[{{version}}](
-	{{~#if @root.repository~}}
-		{{~#if @root.host}}
-			{{~@root.host}}/
-		{{~/if}}
-		{{~#if @root.owner}}
-			{{~@root.owner}}/
-		{{~/if}}
-		{{~@root.repository}}
-	{{~else}}
-		{{~@root.repoUrl}}
-	{{~/if~}}
-	{{~#if previousTag~}}
-		/compare/{{previousTag}}...{{currentTag}}
-	{{~else~}}
-		/tree/{{currentTag}}
-	{{~/if}})
-{{~else}}
-	{{~version}}
-{{~/unless}}
-{{~#if date}} ({{date}})
-{{/if}}

package/lib/templates/release-package.json

@@ -1,12 +0,0 @@
-{
-  "name": null,
-  "version": null,
-  "description": null,
-  "keywords": null,
-  "engines": null,
-  "author": null,
-  "license": null,
-  "homepage": null,
-  "bugs": null,
-  "repository": null
-}

package/lib/templates/template.hbs

@@ -1,25 +0,0 @@
-{{> header}}
-
-{{#if isInternalRelease}}
-Internal changes only (updated dependencies, documentation, etc.).
-
-
-{{else}}
-{{> footer}}
-{{#each commitGroups}}
-### {{title}}
-
-{{#if (lookup @root.additionalNotes title)}}
-{{ lookup @root.additionalNotes title }}
-
-{{/if}}
-{{#each commits}}
-{{> commit root=@root}}
-{{/each}}
-
-{{else}}
-Internal changes only (updated dependencies, documentation, etc.).
-
-{{/each}}
-
-{{/if}}

package/lib/utils/displaycommits.js

@@ -1,103 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-import chalk from 'chalk';
-import { logger } from '@ckeditor/ckeditor5-dev-utils';
-import * as utils from './transformcommitutils.js';
-import { CLI_COMMIT_INDENT_SIZE, CLI_INDENT_SIZE } from './constants.js';
-
-/**
- * @param {Array.<Commit>|Set.<Commit>} commits
- * @param {object} [options={}]
- * @param {boolean} [options.attachLinkToCommit=false] Whether to attach a link to parsed commit.
- * @param {number} [options.indentLevel=1] The indent level.
- */
-export default function displayCommits( commits, options = {} ) {
-	const log = logger();
-
-	const attachLinkToCommit = options.attachLinkToCommit || false;
-	const indentLevel = options.indentLevel || 1;
-	const listIndent = ' '.repeat( CLI_INDENT_SIZE * indentLevel );
-
-	if ( !( commits.length || commits.size ) ) {
-		log.info( listIndent + chalk.italic( 'No commits to display.' ) );
-	}
-
-	const COMMITS_SEPARATOR = listIndent + chalk.gray( '-'.repeat( 112 ) );
-
-	// Group of commits by the commit's hash.
-	/** @type {Map.<string, Set.<Commit>>} */
-	const commitGroups = new Map();
-
-	for ( const singleCommit of commits ) {
-		getCommitGroup( singleCommit ).add( singleCommit );
-	}
-
-	// A flag that helps avoid duplication separators if two groups are consecutive one after another.
-	let finishedWithSeparator = false;
-
-	for ( const [ hash, commits ] of commitGroups ) {
-		// Do not duplicate the separator if it was already added.
-		if ( commits.size > 1 && !finishedWithSeparator ) {
-			log.info( COMMITS_SEPARATOR );
-		}
-
-		for ( const singleCommit of commits.values() ) {
-			const hasCorrectType = utils.availableCommitTypes.has( singleCommit.rawType );
-			const isCommitIncluded = utils.availableCommitTypes.get( singleCommit.rawType );
-
-			const indent = commits.size > 1 ? listIndent.slice( 0, listIndent.length - 1 ) + chalk.gray( '|' ) : listIndent;
-			const noteIndent = indent + ' '.repeat( CLI_COMMIT_INDENT_SIZE );
-
-			let logMessage = `${ indent }* ${ chalk.yellow( hash.slice( 0, 7 ) ) } "${ utils.truncate( singleCommit.header, 100 ) }" `;
-
-			if ( hasCorrectType && isCommitIncluded ) {
-				logMessage += chalk.green( 'INCLUDED' );
-			} else if ( hasCorrectType && !isCommitIncluded ) {
-				logMessage += chalk.gray( 'SKIPPED' );
-			} else {
-				logMessage += chalk.red( 'INVALID' );
-			}
-
-			// Avoid displaying singleCommit merge twice.
-			if ( singleCommit.merge && singleCommit.merge !== singleCommit.header ) {
-				logMessage += `\n${ noteIndent }${ chalk.italic( singleCommit.merge ) }`;
-			}
-
-			for ( const note of singleCommit.notes ) {
-				const limit = 100 - note.title.length;
-
-				logMessage += `\n${ noteIndent }${ note.title }: ${ utils.truncate( note.text, limit ) } `;
-			}
-
-			if ( attachLinkToCommit ) {
-				const url = `${ singleCommit.repositoryUrl }/commit/${ singleCommit.hash }`;
-
-				logMessage += `\n${ noteIndent }${ chalk.gray( url ) }`;
-			}
-
-			log.info( logMessage );
-		}
-
-		if ( commits.size > 1 ) {
-			finishedWithSeparator = true;
-			log.info( COMMITS_SEPARATOR );
-		} else {
-			finishedWithSeparator = false;
-		}
-	}
-
-	/**
-	 * @param {Commit} commit
-	 * @returns {Set.<Commit>}
-	 */
-	function getCommitGroup( commit ) {
-		if ( !commitGroups.has( commit.hash ) ) {
-			commitGroups.set( commit.hash, new Set() );
-		}
-
-		return commitGroups.get( commit.hash );
-	}
-}

package/lib/utils/displayskippedpackages.js

@@ -1,32 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-import { logger, workspaces } from '@ckeditor/ckeditor5-dev-utils';
-import chalk from 'chalk';
-import { CLI_INDENT_SIZE } from './constants.js';
-
-/**
- * Displays skipped packages.
- *
- * @param {Set} skippedPackagesPaths
- */
-export default function displaySkippedPackages( skippedPackagesPaths ) {
-	if ( !skippedPackagesPaths.size ) {
-		return;
-	}
-
-	const indent = ' '.repeat( CLI_INDENT_SIZE );
-	const packageNames = Array.from( skippedPackagesPaths )
-		.map( packagePath => {
-			const { name } = workspaces.getPackageJson( packagePath );
-
-			return name;
-		} );
-
-	let message = indent + chalk.bold.underline( 'Packages listed below have been skipped:' ) + '\n';
-	message += packageNames.map( line => indent + `  * ${ line }` ).join( '\n' );
-
-	logger().info( message );
-}

package/lib/utils/generatechangelog.js

@@ -1,117 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-import { Readable } from 'stream';
-import { stream } from '@ckeditor/ckeditor5-dev-utils';
-import { writeChangelogStream } from 'conventional-changelog-writer';
-
-const UPDATED_TRANSLATION_COMMIT = '* Updated translations.';
-
-/**
- * Generates the changelog based on commits.
- *
- * @param {Array.<Commit>} commits
- *
- * @param {object} context
- * @param {string} context.version Current version for the release.
- * @param {string} context.repoUrl The repository URL.
- * @param {string} context.currentTag A tag for the current version.
- * @param {string} context.commit Commit keyword in the URL.
- * @param {string} [context.previousTag] A tag for the previous version.
- * @param {boolean} [context.skipCommitsLink=false] Whether to skip adding links to commit.
- * @param {boolean} [context.skipCompareLink=false] Whether to remove the compare URL in the header.
- *
- * @param {object} options
- * @param {object} options.transform
- * @param {function} options.transform.hash A function for mapping the commit's hash.
- * @param {Array.<string>|string} options.groupBy A key for grouping the commits.
- * @param {function} options.commitGroupsSort A sort function for the groups.
- * @param {function} options.noteGroupsSort A soft function for the notes.
- * @param {string} options.mainTemplate The main template for the changelog.
- * @param {string} options.headerPartial The "header" partial used in the main template.
- * @param {string} options.commitPartial The "commit" partial used in the main template.
- * @param {string} options.footerPartial The "footer" partial used in the main template.
- *
- * @returns {Promise.<string>}
- */
-export default function generateChangelog( commits, context, options ) {
-	const commitStream = new Readable( { objectMode: true } );
-	/* istanbul ignore next */
-	commitStream._read = function() {};
-
-	for ( const commitItem of commits ) {
-		commitStream.push( commitItem );
-	}
-
-	commitStream.push( null );
-
-	return new Promise( ( resolve, reject ) => {
-		commitStream
-			.pipe( writeChangelogStream( context, options ) )
-			.pipe( stream.noop( changes => {
-				changes = mergeUpdateTranslationsCommits( changes.toString(), {
-					skipCommitsLink: context.skipCommitsLink
-				} );
-
-				resolve( changes );
-			} ) )
-			.on( 'error', reject );
-	} );
-}
-
-/**
- * Merges multiple "Updated translations." entries into the single commit.
- *
- * @param {string} changelog Generated changelog.
- * @param {object} [options={}]
- * @param {boolean} [options.skipCommitsLink=false] Whether to skip adding links to commit.
- * @returns {string}
- */
-function mergeUpdateTranslationsCommits( changelog, options = {} ) {
-	let foundUpdatedTranslationCommit = false;
-
-	const changelogAsArray = changelog.split( '\n' );
-
-	// An array that contains duplicated commits.
-	const removedEntries = [];
-
-	// An array that contains changelog without duplicated entries.
-	const uniqueEntries = changelogAsArray.filter( line => {
-		if ( !line.startsWith( UPDATED_TRANSLATION_COMMIT ) ) {
-			return true;
-		}
-
-		if ( foundUpdatedTranslationCommit ) {
-			removedEntries.push( line );
-
-			return false;
-		}
-
-		foundUpdatedTranslationCommit = true;
-
-		return true;
-	} );
-
-	if ( options.skipCommitsLink ) {
-		return uniqueEntries.join( '\n' );
-	}
-
-	return uniqueEntries.map( line => {
-		if ( !line.startsWith( UPDATED_TRANSLATION_COMMIT ) ) {
-			return line;
-		}
-
-		const newLine = line + ' ' + removedEntries
-			.map( entry => {
-				const match = entry.match( /(\(\[commit\].*)$/ );
-
-				return match ? match[ 1 ] : null;
-			} )
-			.filter( item => !!item )
-			.join( ' ' );
-
-		return newLine.trim().replace( /\) \(/g, ', ' );
-	} ).join( '\n' );
-}

package/lib/utils/getchangedfilesforcommit.js

@@ -1,31 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-import { tools } from '@ckeditor/ckeditor5-dev-utils';
-
-/**
- * Returns an array with paths to changed files for given commit.
- *
- * @param {string} commitId
- * @returns {Array.<string>}
- */
-export default function getChangedFilesForCommit( commitId ) {
-	const gitCommand = `git log -m -1 --name-only --pretty="format:" ${ commitId }`;
-	const changedFiles = tools.shExec( gitCommand, { verbosity: 'error' } ).trim();
-
-	// Merge commits can have two parents. Returned files for merge commits looks like:
-	// file1            <-- files from merged branch
-	// file2            <-- files from merged branch
-	// file             <-- files from merged branch
-	//
-	// other-file1      <-- files from last commit before merge
-	// other-file2      <-- files from last commit before merge
-	// We need to filter out files from commit before merge.
-
-	return changedFiles.split( '\n\n' )[ 0 ]
-		.split( '\n' )
-		.map( file => file.trim() )
-		.filter( item => item );
-}