@ckeditor/ckeditor5-dev-release-tools 32.0.0

package/lib/utils/validatepackagetorelease.js

@@ -0,0 +1,54 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+
+/**
+ * @param {Object} options
+ * @param {String} options.version Version of the current release.
+ * @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.
+ * @returns {Array.<String>}
+ */
+module.exports = function validatePackageToRelease( options ) {
+	const errors = [];
+	const branch = options.branch || 'master';
+
+	// Check whether the repository is ready for the release.
+	const status = exec( 'git status -sb', { verbosity: 'error' } ).trim();
+
+	if ( !options.ignoreBranchCheck ) {
+		// Check whether current branch is "master".
+		if ( !status.startsWith( `## ${ branch }...origin/${ branch }` ) ) {
+			errors.push( `Not on ${ branch } branch.` );
+		}
+	}
+
+	// Check whether the local branch is sync with the remote.
+	if ( status.match( /behind \d+/ ) ) {
+		errors.push( 'The branch is behind with the remote.' );
+	}
+
+	// Check whether specified the version.
+	if ( !options.version ) {
+		errors.push( `Passed an invalid version ("${ options.version }").` );
+
+		return errors;
+	}
+
+	// Check whether the changelog entries are correct.
+	if ( !options.changes ) {
+		errors.push( `Cannot find changelog entries for version "${ options.version }".` );
+	}
+
+	return errors;
+
+	function exec( command ) {
+		return tools.shExec( command, { verbosity: 'error' } );
+	}
+};

package/lib/utils/versions.js

@@ -0,0 +1,59 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+const changelogUtils = require( './changelog' );
+const getPackageJson = require( './getpackagejson' );
+
+const versions = {
+	/**
+	 * Returns a last created version in changelog file.
+	 *
+	 * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
+	 * @returns {String|null}
+	 */
+	getLastFromChangelog( cwd = process.cwd() ) {
+		const changelog = changelogUtils.getChangelog( cwd );
+
+		if ( !changelog ) {
+			return null;
+		}
+
+		const regexp = /\n## \[?([\da-z.\-+]+)/i;
+		const matches = changelog.match( regexp );
+
+		return matches ? matches[ 1 ] : null;
+	},
+
+	/**
+	 * Returns a name of the last created tag.
+	 *
+	 * @returns {String|null}
+	 */
+	getLastTagFromGit() {
+		try {
+			const lastTag = tools.shExec( 'git describe --abbrev=0 --tags 2> /dev/null', { verbosity: 'error' } );
+
+			return lastTag.trim().replace( /^v/, '' ) || null;
+		} catch ( err ) {
+			/* istanbul ignore next */
+			return null;
+		}
+	},
+
+	/**
+	 * Returns version of current package from `package.json`.
+	 *
+	 * @param {String} [cwd=process.cwd()] Current work directory.
+	 * @returns {String}
+	 */
+	getCurrent( cwd = process.cwd() ) {
+		return getPackageJson( cwd ).version;
+	}
+};
+
+module.exports = versions;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@ckeditor/ckeditor5-dev-release-tools",
+  "version": "32.0.0",
+  "description": "Tools used for releasing CKEditor 5 and related packages.",
+  "keywords": [],
+  "main": "lib/index.js",
+  "dependencies": {
+    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
+    "@octokit/rest": "^17.9.2",
+    "chalk": "^4.0.0",
+    "cli-table": "^0.3.1",
+    "compare-func": "^2.0.0",
+    "concat-stream": "^2.0.0",
+    "conventional-changelog-writer": "^4.0.16",
+    "conventional-commits-filter": "^2.0.6",
+    "conventional-commits-parser": "^3.1.0",
+    "diff": "^5.0.0",
+    "git-raw-commits": "^2.0.7",
+    "glob": "^7.1.6",
+    "inquirer": "^7.1.0",
+    "lodash": "^4.17.15",
+    "minimatch": "^3.0.4",
+    "mkdirp": "^1.0.4",
+    "parse-github-url": "^1.0.2",
+    "semver": "^7.3.2"
+  },
+  "devDependencies": {
+    "chai": "^4.2.0",
+    "handlebars": "^4.7.6",
+    "mockery": "^2.1.0",
+    "mock-fs": "^5.1.2",
+    "proxyquire": "^2.1.3",
+    "sinon": "^9.2.4",
+    "strip-ansi": "^6.0.0"
+  },
+  "engines": {
+    "node": ">=14.0.0",
+    "npm": ">=5.7.1"
+  },
+  "files": [
+    "lib"
+  ],
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://github.com/ckeditor/ckeditor5-dev/tree/master/packages/ckeditor5-dev-release-tools",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5-dev.git",
+    "directory": "packages/ckeditor5-dev-release-tools"
+  }
+}