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

package/README.md

@@ -4,81 +4,10 @@ CKEditor 5 release tools
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-dev-release-tools.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-release-tools)
 [![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5-dev.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5-dev?branch=master)
 
-Tasks used during a release of [CKEditor 5](https://ckeditor.com) and related packages.
+Contains tools used during a release of [CKEditor 5](https://ckeditor.com) and related packages.
 
 More information about development tools packages can be found at the following URL: <https://github.com/ckeditor/ckeditor5-dev>.
 
-## Release tools
-
-### Usage
-
-```
-npm i --save-dev @ckeditor/ckeditor5-dev-release-tools
-```
-
-Then create a script that run tasks:
-
-```js
-// scripts/changelog-self.js: Generate changelog for the current package.
-require( '@ckeditor/ckeditor5-dev-release-tools' ).generateChangelogForSinglePackage( /* options */ );
-
-// See the `options` argument:
-// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/generatechangelogforsinglepackage.js#L25-L43
-```
-
-```js
-// scripts/changelog-repos.js: Generate changelog for all dependencies (repository using multiple repositories).
-require( '@ckeditor/ckeditor5-dev-release-tools' ).generateChangelogForMonoRepository( /* options */ );
-
-// See the `options` argument:
-// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/generatechangelogformonorepository.js#L30-L62
-```
-
-```js
-// scripts/release-bump-versions.js: Validates and updates version for all packages (includes the package found in options.cwd)
-require( '@ckeditor/ckeditor5-dev-release-tools' ).bumpVersions( /* options */ );
-
-// See the `options` argument:
-// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/bumpversions.js#L20-L27
-```
-
-```js
-// scripts/release-packages.js: Publish all changes.
-require( '@ckeditor/ckeditor5-dev-release-tools' ).releaseSubRepositories( /* options */ );
-
-// See the `options` argument:
-// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/releasesubrepositories.js#L20-L27
-```
-
-### Generating changelog
-
-This tool can generate a changelog file based on commits in the repository. It can also propose what should be the next release version (according to [SemVer](http://semver.org)).
-
-Read more about the [git commit message convention](https://github.com/ckeditor/ckeditor5-design/wiki/Git-commit-message-convention) implemented by this tool.
-
-### Creating a release for multiple repositories
-
-**Note:** Before running the bumping versions task you need to generate the changelog for changes in the version to be released.
-
-The process implemented by the tool:
-
-1. Read a new release version from the changelog (the last header),
-1. Filter out packages which won't be released (no changes or dependencies has not changed),
-1. Update new versions of packages in `package.json` for all released packages,
-1. Commit these changes as `Release: vX.Y.Z.`,
-1. Create a tag `vX.Y.Z`.
-
-### Publishing changes
-
-**Note:** Before publishing changes you need to bump versions in all dependencies.
-
-The process implemented by the tool:
-
-1. Compares versions released on NPM and GitHub. Based on that, the tool know what should be published. You can call the same script multiple times and nothing wrong happens.
-1. If choose publish on NPM: the tool publish changes on NPM.
-1. If choose publish on GitHub: the tool creates a [GitHub release](https://help.github.com/articles/creating-releases/). Notes for the release are taken from the changelog.
-1. If nothing was selected: the tool does nothing. No publish, no push, no creating releases.
-
 ## Changelog
 
 See the [`CHANGELOG.md`](https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/CHANGELOG.md) file.

package/lib/index.js

@@ -5,8 +5,6 @@
 
 import { npm, workspaces } from '@ckeditor/ckeditor5-dev-utils';
 
-export { default as generateChangelogForSinglePackage } from './tasks/generatechangelogforsinglepackage.js';
-export { default as generateChangelogForMonoRepository } from './tasks/generatechangelogformonorepository.js';
 export { default as updateDependencies } from './tasks/updatedependencies.js';
 export { default as commitAndTag } from './tasks/commitandtag.js';
 export { default as createGithubRelease } from './tasks/creategithubrelease.js';
@@ -29,7 +27,6 @@ export {
 } from './utils/versions.js';
 export { default as getChangesForVersion } from './utils/getchangesforversion.js';
 export { default as getChangelog } from './utils/getchangelog.js';
-export { default as saveChangelog } from './utils/savechangelog.js';
 export { default as executeInParallel } from './utils/executeinparallel.js';
 export { default as validateRepositoryToRelease } from './utils/validaterepositorytorelease.js';
 export { default as getNpmTagFromVersion } from './utils/getnpmtagfromversion.js';

package/lib/utils/constants.js

@@ -12,15 +12,3 @@ export const CHANGELOG_FILE = 'CHANGELOG.md';
  * Changelog header.
  */
 export const CHANGELOG_HEADER = 'Changelog\n=========\n\n';
-
-/**
- * A size of default indent for a log.
- */
-export const CLI_INDENT_SIZE = 3;
-
-/**
- * A size of indent for a second and next lines in a log. The number is equal to length of the log string:
- * '* 1234567 ', where '1234567' is a short commit id.
- * It does not include a value from `cli.INDENT_SIZE`.
- */
-export const CLI_COMMIT_INDENT_SIZE = 10;

package/lib/utils/validaterepositorytorelease.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-import { tools } from '@ckeditor/ckeditor5-dev-utils';
+import { simpleGit } from 'simple-git';
 
 /**
  * @param {object} options
@@ -11,6 +11,7 @@ import { tools } from '@ckeditor/ckeditor5-dev-utils';
  * @param {string} options.changes Changelog entries for the current release.
  * @param {boolean} [options.ignoreBranchCheck=false] If set on true, branch checking will be skipped.
  * @param {string} [options.branch='master'] A name of the branch that should be used for releasing packages.
+ * @param {string} [options.cwd] Current working directory in which git status will be checked.
  * @returns {Promise.<Array.<string>>}
  */
 export default async function validateRepositoryToRelease( options ) {
@@ -18,22 +19,25 @@ export default async function validateRepositoryToRelease( options ) {
 		version,
 		changes,
 		ignoreBranchCheck = false,
-		branch = 'master'
+		branch = 'master',
+		cwd = process.cwd()
 	} = options;
+
 	const errors = [];
+	const git = simpleGit( { baseDir: cwd } );
 
 	// Check whether the repository is ready for the release.
-	const status = ( await exec( 'git status -sb' ) ).trim();
+	const status = await git.status();
 
 	if ( !ignoreBranchCheck ) {
 		// Check whether current branch is "master".
-		if ( !status.startsWith( `## ${ branch }` ) ) {
+		if ( status.current !== branch ) {
 			errors.push( `Not on the "#${ branch }" branch.` );
 		}
 	}
 
 	// Check whether the local branch is sync with the remote.
-	if ( status.match( /behind \d+/ ) ) {
+	if ( status.behind ) {
 		errors.push( 'The branch is behind with the remote.' );
 	}
 
@@ -50,8 +54,4 @@ export default async function validateRepositoryToRelease( options ) {
 	}
 
 	return errors;
-
-	async function exec( command ) {
-		return tools.shExec( command, { verbosity: 'error', async: true } );
-	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "51.1.0",
+  "version": "52.0.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -22,22 +22,13 @@
     "lib"
   ],
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^51.1.0",
+    "@ckeditor/ckeditor5-dev-utils": "^52.0.0",
     "@octokit/rest": "^22.0.0",
     "chalk": "^5.0.0",
     "cli-columns": "^4.0.0",
-    "compare-func": "^2.0.0",
-    "concat-stream": "^2.0.0",
-    "conventional-changelog-writer": "^8.0.0",
-    "conventional-commits-filter": "^5.0.0",
-    "conventional-commits-parser": "^6.0.0",
-    "date-fns": "^4.0.0",
-    "es-toolkit": "^1.35.0",
     "fs-extra": "^11.0.0",
-    "git-raw-commits": "^5.0.0",
     "glob": "^11.0.2",
     "inquirer": "^12.5.2",
-    "minimatch": "^10.0.1",
     "semver": "^7.6.3",
     "shell-escape": "^0.2.0",
     "simple-git": "^3.27.0",