@eclipse-docks/cli 0.7.137 → 0.7.140

package/README.md

@@ -12,6 +12,7 @@ npx @eclipse-docks/cli release v1.2.3                # explicit version
 npx @eclipse-docks/cli release --since v1.2.0        # notes from commits since that tag
 npx @eclipse-docks/cli release --dry-run             # print what would be tagged
 npx @eclipse-docks/cli release --no-push             # create the tag locally without pushing
+npx @eclipse-docks/cli release --skip-tests          # skip the project's release:checks script
 ```
 
 ## `release`
@@ -27,6 +28,10 @@ If CI fails after the tag was pushed, that workflow deletes the orphan remote ta
 GitHub Release history has no gaps. Remove the local tag before retrying:
 `git tag -d vX.Y.Z`.
 
+If the project's `package.json` defines a `release:checks` script (e.g. type check and
+tests), it runs before the version is tagged, and a failure aborts the release. Pass
+`--skip-tests` to skip it, e.g. `npm run release -- --skip-tests`.
+
 The last version is the most recent `vX.Y.Z` tag reachable from `HEAD` (via
 `git describe`), not the highest semver tag in the repository. That drives the
 default bump and changelog range.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-docks/cli",
-  "version": "0.7.137",
+  "version": "0.7.140",
   "description": "Developer CLI for Eclipse Docks apps (release automation and more)",
   "type": "module",
   "bin": {

package/src/commands/release.js

@@ -1,8 +1,11 @@
 import { spawnSync } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
 import { createInterface } from 'node:readline/promises';
 
 /** CLI arg / release tag name: exact `vX.Y.Z`. */
 const VERSION_RE = /^v\d+\.\d+\.\d+$/;
+const CHECKS_SCRIPT = 'release:checks';
 
 function git(args, cwd) {
   const result = spawnSync('git', args, { cwd, encoding: 'utf8' });
@@ -18,11 +21,11 @@ function gitOrNull(args, cwd) {
 }
 
 function usage() {
-  return 'Usage: docks release [major|minor|patch|vX.Y.Z] [-m "release notes"] [--since vX.Y.Z] [--dry-run] [--no-push]';
+  return 'Usage: docks release [major|minor|patch|vX.Y.Z] [-m "release notes"] [--since vX.Y.Z] [--dry-run] [--no-push] [--skip-tests]';
 }
 
 function parseArgs(argv) {
-  const opts = { bump: 'patch', version: '', since: '', notes: '', dryRun: false, push: true };
+  const opts = { bump: 'patch', version: '', since: '', notes: '', dryRun: false, push: true, skipTests: false };
 
   for (let i = 0; i < argv.length; i++) {
     const arg = argv[i];
@@ -44,6 +47,8 @@ function parseArgs(argv) {
       opts.push = true;
     } else if (arg === '--no-push') {
       opts.push = false;
+    } else if (arg === '--skip-tests') {
+      opts.skipTests = true;
     } else {
       throw new Error(`Unknown argument: ${arg}\n${usage()}`);
     }
@@ -52,6 +57,37 @@ function parseArgs(argv) {
   return opts;
 }
 
+function hasChecksScript(cwd) {
+  try {
+    const pkg = JSON.parse(readFileSync(join(cwd, 'package.json'), 'utf8'));
+    return Boolean(pkg.scripts?.[CHECKS_SCRIPT]);
+  } catch {
+    return false;
+  }
+}
+
+function runChecks(cwd, { skip, dryRun }) {
+  if (!hasChecksScript(cwd)) return;
+  if (skip) {
+    console.log(`Skipping npm run ${CHECKS_SCRIPT} (--skip-tests).`);
+    return;
+  }
+  if (dryRun) {
+    console.log(`[dry run] would run npm run ${CHECKS_SCRIPT}`);
+    return;
+  }
+
+  console.log(`Running npm run ${CHECKS_SCRIPT}...`);
+  const result = spawnSync('npm', ['run', CHECKS_SCRIPT], {
+    cwd,
+    stdio: 'inherit',
+    shell: process.platform === 'win32',
+  });
+  if (result.status !== 0) {
+    throw new Error(`npm run ${CHECKS_SCRIPT} failed; fix it or rerun with --skip-tests.`);
+  }
+}
+
 function findLastVersion(cwd) {
   const tag = gitOrNull(['describe', '--tags', '--abbrev=0', '--match', 'v*', 'HEAD'], cwd);
   if (!tag) return null;
@@ -178,6 +214,8 @@ export async function release(argv, cwd = process.cwd()) {
     throw new Error('Working tree is not clean. Commit or stash your changes first.');
   }
 
+  runChecks(cwd, { skip: opts.skipTests, dryRun: opts.dryRun });
+
   const last = findLastVersion(cwd);
   let version = opts.version;
   if (!version) {