@williamthorsen/release-kit 10.5.0 → 10.6.0

package/dist/esm/runGitCliff.d.ts

@@ -1,3 +1,12 @@
+/**
+ * The exact `git-cliff` version every invocation resolves.
+ *
+ * npm's `git-cliff` trails the upstream release, so this pin normally sits behind the newest version cliff
+ * itself reports. Bumping it is an edit to this line, once npm publishes the version you want.
+ */
+export declare const GIT_CLIFF_VERSION = "2.13.1";
+/** The npx arguments that precede the cliff args at every invocation, and that the dry-run report renders. */
+export declare const GIT_CLIFF_NPX_ARGS: readonly string[];
 /**
  * Invokes `git-cliff` via `npx` and returns the output it produced.
  *
@@ -9,15 +18,14 @@
  * entire matching tag history on every run, so its size grows without bound with the repo;
  * a file accommodates that, while a pipe is bounded by `maxBuffer`.
  *
- * The `--prefer-offline` flag and `npm_config_progress=false` env entry are deliberate: `--prefer-offline` skips
- * npx's per-call npm-registry revalidation HTTP round-trip (~2.5 s per invocation on a warm cache), and
- * `npm_config_progress=false` suppresses npx's animated stderr spinner, which otherwise renders as a transient flicker.
+ * The npx spec names an exact version, which leaves npm no staleness to check, so `--prefer-offline` skips the
+ * per-call registry revalidation round-trip (~2.5 s per invocation on a warm cache) without stranding the run
+ * on whatever the cache happens to hold.
  *
- * Because `--prefer-offline` also suppresses npx's cache-staleness check, the cached `git-cliff` binary
- * would otherwise drift further and further behind upstream, with each cliff invocation re-emitting the
- * "A new version of git-cliff is available" notice and the local cache never updating.
- * `refreshGitCliffCache` (below) revalidates the cache once at the top of each `prepare` run so that
- * subsequent `--prefer-offline` calls run against a current binary.
+ * Two env entries are set for the child. `npm_config_progress=false` suppresses npx's animated stderr spinner,
+ * which otherwise renders as a transient flicker. `RUST_LOG=warn` drops cliff's INFO lines, among them the
+ * crates.io update notice it emits on every invocation while npm trails upstream, and leaves warnings and errors
+ * in place; an inherited `RUST_LOG` wins, so raising the level for debugging still works.
  *
  * The helper injects `--config <path>` and `--output <path>` itself — callers must NOT include either in `cliffArgs`.
  * `--output` is appended last so a caller that passes one anyway cannot redirect the output the helper then reads.
@@ -28,18 +36,3 @@
  * The temp-dir cleanup runs in a `finally` so it still happens on throw.
  */
 export declare function runGitCliff(cliffConfigPath: string, cliffArgs: readonly string[]): string;
-/**
- * Revalidate npx's cache for `git-cliff` once per `prepare` run.
- *
- * Spawns `npx --yes git-cliff --version` *without* `--prefer-offline`, so that npm performs its normal
- * registry-staleness check and refreshes the cached binary if a newer version is available.
- * Subsequent `runGitCliff` calls within the same run keep `--prefer-offline` (preserving the per-call perf win)
- * but now run against an up-to-date cache, so git-cliff's own self-update notice no longer fires repeatedly.
- *
- * Stdio: stdin ignored, stdout piped (the version line is suppressed as noise), stderr inherited (npm errors and
- * any rare upgrade notice surface, but only once per run). `maxBuffer` is declared even though the piped output
- * is a single version line, because every call that pipes stdout declares one.
- *
- * Errors propagate unchanged — a failed cache refresh fails the prepare run loudly rather than silently degrading.
- */
-export declare function refreshGitCliffCache(): void;

package/dist/esm/runGitCliff.js

@@ -2,7 +2,8 @@ import { execFileSync } from 'node:child_process';
 import { copyFileSync, mkdtempSync, readFileSync, rmSync } from 'node:fs';
 import { tmpdir } from 'node:os';
 import { join } from 'node:path';
-import { GIT_OUTPUT_LIMIT } from '@williamthorsen/nmr-core';
+export const GIT_CLIFF_VERSION = '2.13.1';
+export const GIT_CLIFF_NPX_ARGS = ['--prefer-offline', '--yes', `git-cliff@${GIT_CLIFF_VERSION}`];
 export function runGitCliff(cliffConfigPath, cliffArgs) {
     const tempDir = mkdtempSync(join(tmpdir(), 'cliff-'));
     try {
@@ -12,9 +13,9 @@ export function runGitCliff(cliffConfigPath, cliffArgs) {
             copyFileSync(cliffConfigPath, configPath);
         }
         const outputPath = join(tempDir, 'output.json');
-        execFileSync('npx', ['--prefer-offline', '--yes', 'git-cliff', '--config', configPath, ...cliffArgs, '--output', outputPath], {
+        execFileSync('npx', [...GIT_CLIFF_NPX_ARGS, '--config', configPath, ...cliffArgs, '--output', outputPath], {
             stdio: ['ignore', 'ignore', 'inherit'],
-            env: { ...process.env, npm_config_progress: 'false' },
+            env: { ...process.env, npm_config_progress: 'false', RUST_LOG: process.env['RUST_LOG'] ?? 'warn' },
         });
         return readFileSync(outputPath, 'utf8');
     }
@@ -22,10 +23,3 @@ export function runGitCliff(cliffConfigPath, cliffArgs) {
         rmSync(tempDir, { recursive: true, force: true });
     }
 }
-export function refreshGitCliffCache() {
-    execFileSync('npx', ['--yes', 'git-cliff', '--version'], {
-        maxBuffer: GIT_OUTPUT_LIMIT,
-        stdio: ['ignore', 'pipe', 'inherit'],
-        env: { ...process.env, npm_config_progress: 'false' },
-    });
-}

package/dist/esm/types.d.ts

@@ -18,6 +18,15 @@ export interface ChangelogItem {
      * with the canonical SSOT values) to surface them prominently in release notes.
      */
     breaking?: boolean;
+    /**
+     * Migration instruction for a consumer, taken from the `Migration:` paragraph of `body`.
+     *
+     * Derived from `body` wherever `body` is set, and absent where the body carries no labeled
+     * paragraph. Independent of `breaking`: a `fix` that tightens validation cannot carry `!` under
+     * the default breaking policy and still imposes a migration. `body` keeps the paragraph, so
+     * `CHANGELOG.md` goes on rendering it in place.
+     */
+    migration?: string;
     /**
      * Full git commit SHA when known. Captured from git-cliff's `--context` output and
      * persisted in `changelog.json` so that override files can target items by hash. Synthetic

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "10.5.0",
+  "version": "10.6.0",
   "description": "Version-bumping and changelog-generation toolkit for release workflows",
   "keywords": [
     "changelog",
@@ -38,29 +38,30 @@
     "release-kit": "./bin/release-kit.js"
   },
   "files": [
+    ".meta/changelog.json",
     ".readyup/kits/*.js",
     ".readyup/manifest.json",
+    "CHANGELOG.md",
     "bin",
-    "dist/*",
     "cliff.toml.template",
+    "dist/*",
     "presets/**",
-    "schemas/**",
-    "CHANGELOG.md"
+    "schemas/**"
   ],
   "dependencies": {
-    "@williamthorsen/nmr-core": "0.10.4",
-    "@williamthorsen/toolbelt.errors": "0.6.3",
+    "@williamthorsen/nmr-core": "0.11.0",
+    "@williamthorsen/toolbelt.errors": "0.7.0",
     "glob": "13.0.6",
     "json-stringify-pretty-compact": "4.0.0",
     "semver": "7.8.5",
     "yaml": "2.9.0",
-    "zod": "4.4.3"
+    "zod": "4.5.4"
   },
   "devDependencies": {
     "@types/semver": "7.8.0",
-    "@williamthorsen/toolbelt.filesystem": "0.8.2",
-    "@williamthorsen/toolbelt.testing": "0.5.0",
-    "@williamthorsen/toolbelt.vitest": "0.8.0",
+    "@williamthorsen/toolbelt.filesystem": "0.8.3",
+    "@williamthorsen/toolbelt.testing": "0.5.1",
+    "@williamthorsen/toolbelt.vitest": "0.9.0",
     "readyup": "0.35.0",
     "smol-toml": "1.8.0"
   },