@eclipse-docks/cli 0.7.118 → 0.7.122

package/README.md

@@ -9,22 +9,26 @@ npx @eclipse-docks/cli release                       # bump patch, prompt for re
 npx @eclipse-docks/cli release minor                 # bump minor
 npx @eclipse-docks/cli release major -m "notes"      # bump major with inline release notes
 npx @eclipse-docks/cli release v1.2.3                # explicit version
-npx @eclipse-docks/cli release --since v1.2.0        # notes from that version (bump still from latest)
-npx @eclipse-docks/cli release --dry-run             # print what would be committed
-npx @eclipse-docks/cli release --no-push             # commit locally without pushing
+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
 ```
 
 ## `release`
 
-Creates an empty commit whose subject is the next version (`vX.Y.Z`) and pushes it.
-Pair this with a CI workflow that tags/releases on that commit subject (see
-[`.github/workflows/app-release.yml`](../../.github/workflows/app-release.yml) for a
-reusable one) — the commit body becomes the release notes.
+Creates an annotated tag whose name is the version (`vX.Y.Z`) and pushes it.
+When pushing (the default), any unpushed commits on the current branch are pushed
+to `origin` first. The tag message body becomes the GitHub Release notes.
 
-The last version is taken from the most recent commit whose subject is exactly `vX.Y.Z`
-or the legacy form `Release: vX.Y.Z`. That drives the default bump.
+Wire release in CI with [`.github/workflows/app-release.yml`](../../.github/workflows/app-release.yml):
+downstream apps usually trigger it on `v*` tag push; this monorepo waits for a green
+**CI** run on `main` first (see [`.github/workflows/release.yml`](../../.github/workflows/release.yml)).
+
+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.
 
 If no release notes are given via `-m`, an end-user-facing summary is generated from the
-commits since that version (or since `--since vX.Y.Z` when set), grouped under
-**Features**, **Fixes**, **Docs**, and **Chore/Refactor**, and offered as the default
-(press Enter on an empty first line to accept it).
+commits since that tag (or since `--since vX.Y.Z` when set), grouped under **Features**,
+**Fixes**, **Docs**, and **Chore/Refactor**, and offered as the default (press Enter on
+an empty first line to accept it).

package/package.json

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

package/src/commands/release.js

@@ -1,10 +1,8 @@
 import { spawnSync } from 'node:child_process';
 import { createInterface } from 'node:readline/promises';
 
-/** CLI arg / new release commit subject: exact `vX.Y.Z`. */
+/** CLI arg / release tag name: exact `vX.Y.Z`. */
 const VERSION_RE = /^v\d+\.\d+\.\d+$/;
-/** Discover last release from exact `vX.Y.Z` or legacy `Release: vX.Y.Z`. */
-const VERSION_IN_SUBJECT_RE = /^(?:Release:\s*)?(v\d+\.\d+\.\d+)$/i;
 
 function git(args, cwd) {
   const result = spawnSync('git', args, { cwd, encoding: 'utf8' });
@@ -19,12 +17,6 @@ function gitOrNull(args, cwd) {
   return result.status === 0 ? result.stdout.trim() : null;
 }
 
-function parseVersionSubject(subject) {
-  const m = subject.trim().match(VERSION_IN_SUBJECT_RE);
-  if (!m) return null;
-  return `v${m[1].slice(1)}`;
-}
-
 function usage() {
   return 'Usage: docks release [major|minor|patch|vX.Y.Z] [-m "release notes"] [--since vX.Y.Z] [--dry-run] [--no-push]';
 }
@@ -61,21 +53,57 @@ function parseArgs(argv) {
 }
 
 function findLastVersion(cwd) {
-  const log = gitOrNull(['log', '--pretty=%s'], cwd);
-  if (!log) return null;
-  for (const subject of log.split('\n')) {
-    const version = parseVersionSubject(subject);
-    if (version) return version;
-  }
-  return null;
+  const tag = gitOrNull(['describe', '--tags', '--abbrev=0', '--match', 'v*', 'HEAD'], cwd);
+  if (!tag) return null;
+  const trimmed = tag.trim();
+  return VERSION_RE.test(trimmed) ? trimmed : null;
 }
 
 function findVersionCommit(cwd, version) {
-  const escaped = version.replace(/\./g, '\\.');
-  return gitOrNull(
-    ['log', '-E', '-i', '--pretty=%H', '-1', `--grep=^(Release:[[:space:]]*)?${escaped}$`],
-    cwd,
-  );
+  return gitOrNull(['rev-parse', '--verify', `${version}^{commit}`], cwd);
+}
+
+function currentBranch(cwd) {
+  const branch = gitOrNull(['rev-parse', '--abbrev-ref', 'HEAD'], cwd);
+  if (!branch || branch === 'HEAD') return null;
+  return branch;
+}
+
+function upstreamStatus(cwd) {
+  const upstream = gitOrNull(['rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'], cwd);
+  if (!upstream) return null;
+  const counts = git(['rev-list', '--left-right', '--count', `${upstream}...HEAD`], cwd);
+  const [behind, ahead] = counts.split('\t').map(Number);
+  return { upstream, behind, ahead };
+}
+
+function pushBranchIfNeeded(cwd, { dryRun = false } = {}) {
+  const branch = currentBranch(cwd);
+  if (!branch) {
+    throw new Error('Detached HEAD — checkout a branch before releasing.');
+  }
+
+  const status = upstreamStatus(cwd);
+  if (!status) {
+    throw new Error(`Branch ${branch} has no upstream. Push it first:\n  git push -u origin ${branch}`);
+  }
+
+  if (status.behind > 0) {
+    throw new Error(
+      `Branch ${branch} is ${status.behind} commit(s) behind ${status.upstream}. Pull before releasing.`,
+    );
+  }
+
+  if (status.ahead === 0) return branch;
+
+  if (dryRun) {
+    console.log(`[dry run] would push ${status.ahead} commit(s) to origin ${branch}`);
+    return branch;
+  }
+
+  console.log(`Pushing ${status.ahead} commit(s) to origin ${branch}...`);
+  git(['push', 'origin', branch], cwd);
+  return branch;
 }
 
 function bumpVersion(last, bump) {
@@ -93,7 +121,7 @@ function bumpVersion(last, bump) {
 function generateSummary(cwd, since) {
   const sinceCommit = since ? findVersionCommit(cwd, since) : null;
   if (since && !sinceCommit) {
-    throw new Error(`No commit found for --since ${since} (expected subject "${since}" or "Release: ${since}").`);
+    throw new Error(`No tag found for --since ${since}.`);
   }
   const range = sinceCommit ? `${sinceCommit}..HEAD` : 'HEAD';
 
@@ -101,7 +129,7 @@ function generateSummary(cwd, since) {
   const buckets = { features: [], fixes: [], docs: [], chores: [] };
 
   for (const subject of log.split('\n')) {
-    if (!subject || parseVersionSubject(subject)) continue;
+    if (!subject || VERSION_RE.test(subject.trim())) continue;
 
     const stripped = subject.includes(': ') ? subject.slice(subject.indexOf(': ') + 2) : subject;
     const text = stripped.charAt(0).toUpperCase() + stripped.slice(1);
@@ -154,7 +182,7 @@ export async function release(argv, cwd = process.cwd()) {
   let version = opts.version;
   if (!version) {
     version = bumpVersion(last ?? 'v0.0.0', opts.bump);
-    console.log(`Last version commit: ${last ?? 'v0.0.0'}`);
+    console.log(`Last release tag: ${last ?? 'v0.0.0'}`);
   }
 
   if (gitOrNull(['rev-parse', version], cwd)) {
@@ -164,29 +192,38 @@ export async function release(argv, cwd = process.cwd()) {
   let notes = opts.notes;
   if (!notes) {
     const since = opts.since || last;
-    if (opts.since) console.log(`Summarizing commits since ${opts.since}`);
+    if (since) console.log(`Summarizing commits since ${since}`);
     const summary = generateSummary(cwd, since);
     notes = await promptNotes(version, summary);
   }
 
   if (opts.dryRun) {
-    console.log(`\n[dry run] would create empty commit:\n  ${version}\n`);
+    if (opts.push) pushBranchIfNeeded(cwd, { dryRun: true });
+    console.log(`\n[dry run] would create annotated tag ${version} at HEAD`);
     console.log(notes.replace(/^/gm, '  '));
     if (opts.push) {
-      const branch = git(['rev-parse', '--abbrev-ref', 'HEAD'], cwd);
-      console.log(`[dry run] would push to origin ${branch}`);
+      console.log(`[dry run] would push tag to origin ${version}`);
     }
     return;
   }
 
-  git(['commit', '--allow-empty', '-m', version, '-m', notes], cwd);
+  if (opts.push) {
+    pushBranchIfNeeded(cwd);
+  }
+
+  const tagArgs = ['tag', '-a', version, '-m', version];
+  if (notes.trim()) {
+    tagArgs.push('-m', notes.trimEnd());
+  }
+  git(tagArgs, cwd);
 
-  const branch = git(['rev-parse', '--abbrev-ref', 'HEAD'], cwd);
   if (opts.push) {
-    git(['push', 'origin', branch], cwd);
-    console.log(`\nPushed ${version} to origin/${branch}; the release workflow will take over.`);
+    git(['push', 'origin', version], cwd);
+    console.log(`\nPushed tag ${version}; the release workflow will take over.`);
   } else {
-    console.log(`\nCreated release commit for ${version}. Push it to trigger the release:`);
-    console.log(`  git push origin ${branch}`);
+    console.log(`\nCreated annotated tag ${version}. Push your branch and tag to trigger the release:`);
+    const branch = currentBranch(cwd);
+    if (branch) console.log(`  git push origin ${branch}`);
+    console.log(`  git push origin ${version}`);
   }
 }