@williamthorsen/release-kit 16.1.2 → 17.0.0

package/dist/esm/validateOverridesCommand.js

@@ -1,5 +1,6 @@
 import { formatErrorLine, formatStatusLine, isAnticipatedFailure, } from '@williamthorsen/nmr-core';
 import { describeError } from '@williamthorsen/toolbelt.errors';
+import { BIN } from "./bin.js";
 import { buildChangelogEntries } from "./buildChangelogEntries.js";
 import { resolveOverridePath } from "./changelogOverrides.js";
 import { describeEmptyWorkspace, discoverWorkspaces } from "./discoverWorkspaces.js";
@@ -26,12 +27,12 @@ export async function validateOverridesCommand(styles, configPath, dependencies
         if (!isAnticipatedFailure(error)) {
             throw error;
         }
-        return { exitCode: 2, message: formatErrorLine(`Failed to discover workspaces: ${describeError(error)}`) };
+        return { exitCode: 2, message: formatErrorLine(BIN, `Failed to discover workspaces: ${describeError(error)}`) };
     }
     if (workspace.kind === 'empty') {
         return {
             exitCode: 2,
-            message: formatErrorLine(`No workspace package to validate. ${describeEmptyWorkspace(workspace)}`),
+            message: formatErrorLine(BIN, `No workspace package to validate. ${describeEmptyWorkspace(workspace)}`),
         };
     }
     let inputs;
@@ -42,7 +43,7 @@ export async function validateOverridesCommand(styles, configPath, dependencies
         if (!isAnticipatedFailure(error)) {
             throw error;
         }
-        return { exitCode: 2, message: formatErrorLine(`Failed to resolve overrides scope: ${describeError(error)}`) };
+        return { exitCode: 2, message: formatErrorLine(BIN, `Failed to resolve overrides scope: ${describeError(error)}`) };
     }
     const result = validate(inputs);
     return formatValidateOverridesResult(result, styles.stderr);
@@ -90,7 +91,7 @@ function flattenEntriesToItems(entries) {
 }
 function formatConfigProblem(problem) {
     return problem.kind === 'load'
-        ? formatErrorLine(`Failed to load config: ${problem.message}`)
+        ? formatErrorLine(BIN, `Failed to load config: ${problem.message}`)
         : `Invalid config:\n  - ${problem.errors.join('\n  - ')}`;
 }
 function buildValidationInputs({ targets, settings }, buildEntries) {

package/docs/configuration.md

@@ -193,7 +193,7 @@ The `RELEASE_KIT_OUTPUT_STYLE` environment variable sets the style for every com
 | `plain` | Print plain on both streams.                                             |
 | `rich`  | Print rich on both streams, even in a pipe or under CI.                  |
 
-Any other value is a usage error: release-kit reports it and exits with code 1.
+Any other value is a usage error: release-kit reports it and exits with code 2.
 
 The variable outranks detection. Under `auto`, release-kit defers to detection, which reads `CI`, then the stream, then `TERM`. A stream is plain when any of these holds, and rich otherwise:
 

package/docs/editorial-overrides.md

@@ -162,6 +162,8 @@ An override file references it from its top-level `$schema` key:
 }
 ```
 
+release-kit also ships the schema in its package. A project that lists `@williamthorsen/release-kit` as a direct dependency can reference the installed version by a path relative to the override file: `../node_modules/@williamthorsen/release-kit/schemas/changelog-overrides.json` from `.meta/changelog-overrides.json`, and `../../../node_modules/@williamthorsen/release-kit/schemas/changelog-overrides.json` from a workspace's `packages/<ws>/.meta/changelog-overrides.json`. pnpm links only direct dependencies into a project's `node_modules`, so the path does not resolve when release-kit runs through `pnpm dlx` or `npx`.
+
 The schema states the key form and the entry fields. It accepts `audience` values `'all'` and `'dev'`, which the file format declares; the loader still rejects them (see below).
 
 ## Audience semantics: v1 supports `'skip'` only

package/docs/labels.md

@@ -125,4 +125,6 @@ Consumers reference it from the top of their `.meta/label-map.json`:
 }
 ```
 
+change-grammar also ships the schema in its package. A project that lists `@williamthorsen/change-grammar` as a direct devDependency can reference the installed version as `../node_modules/@williamthorsen/change-grammar/schemas/label-map.json`, relative to `.meta/label-map.json`. release-kit depends on change-grammar, but pnpm links only direct dependencies into a project's `node_modules`, so the path does not resolve through release-kit alone; the URL works either way.
+
 Earlier releases published the same schema from release-kit, and URLs under existing `release-kit-v*` tags keep resolving. release-kit does not generate `.meta/label-map.json`; change-grammar's `deriveLabelMap` derives one from the taxonomy, the workspace scopes, and the caller's statement of whether the repo is a monorepo, which decides the `root` scope.

package/docs/releasing.md

@@ -65,7 +65,7 @@ Before it writes any file, and in a dry run as well, `prepare` asks npm about ea
 
 ### Packages whose tarball would lack a manifest file
 
-Before it writes any file, and in a dry run as well, `prepare` packs each publishable package that the release includes as the publish workflow would: It clones HEAD into a temporary directory, runs the package manager's frozen install there, runs the package's `prepublishOnly` script when it declares one, and packs the package. Build output in the working tree therefore does not count, and the check adds the time of one install and one build to every release. `prepare` refuses the release when a tarball lacks a file named by the package's `main`, `types`, `bin`, or `exports`, and names each package with each missing path and the manifest field that names it. The usual fix is to build the files in the package's publish lifecycle, such as in a `prepack` script. A failed install or build in the clean checkout also refuses the release, with the failing step's output.
+Before it writes any file, and in a dry run as well, `prepare` packs each publishable package that the release includes as the publish workflow would: It clones HEAD into a temporary directory, runs the package manager's frozen install there, runs the package's `prepublishOnly` script when it declares one, and packs the package. Build output in the working tree therefore does not count, and the check adds the time of one install and one build to every release. `prepare` refuses the release when a tarball lacks a file named by the package's `main`, `types`, `bin`, or `exports`, and names each package with each missing path and the manifest field that names it. The usual fix is to build the files in the package's `prepublishOnly` script, as `"prepublishOnly": "nmr build"` does. A failed install or build in the clean checkout also refuses the release, with the failing step's output.
 
 A target under the `source` export condition is exempt, and so is a target under a condition listed in [`devExportConditions`](configuration.md#releasekitconfig-reference), which declares the conditions that resolve only inside the repo. [`publish`](publishing.md#tarball-check) runs the same check before it publishes any package.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "16.1.2",
+  "version": "17.0.0",
   "description": "Version-bumping and changelog-generation toolkit for release workflows",
   "keywords": [
     "changelog",
@@ -51,8 +51,8 @@
     "templates"
   ],
   "dependencies": {
-    "@williamthorsen/change-grammar": "0.3.0",
-    "@williamthorsen/nmr-core": "0.15.1",
+    "@williamthorsen/change-grammar": "0.3.1",
+    "@williamthorsen/nmr-core": "0.16.0",
     "@williamthorsen/toolbelt.errors": "0.9.0",
     "json-stringify-pretty-compact": "4.0.0",
     "semver": "7.8.6",

package/dist/esm/configFlagSchema.d.ts

@@ -1,12 +0,0 @@
-/**
- * The `--config` flag, shared by every subcommand that reads the config file.
- *
- * Spread into a subcommand's own schema rather than repeated, so that the subcommands cannot drift to different
- * spellings of one flag.
- */
-export declare const configFlagSchema: {
-    config: {
-        long: string;
-        type: "string";
-    };
-};

package/dist/esm/configFlagSchema.js

@@ -1,3 +0,0 @@
-export const configFlagSchema = {
-    config: { long: '--config', type: 'string' },
-};

package/dist/esm/help/initHelp.d.ts

@@ -1,4 +0,0 @@
-/** Prints the `init` command's help text. */
-export declare function showInitHelp(): void;
-/** Prints the `update-templates` command's help text. */
-export declare function showUpdateTemplatesHelp(): void;

package/dist/esm/help/initHelp.js

@@ -1,31 +0,0 @@
-export function showInitHelp() {
-    console.info(`
-Usage: release-kit init [options]
-
-Initialize release-kit in the current repository.
-By default, scaffolds only the GitHub Actions workflow files. When every
-package is private, skips publish.yaml and create-github-release.yaml.
-
-Options:
-  --with-config   Also scaffold .config/release-kit.config.ts
-  --force         Overwrite existing files instead of skipping them
-  --dry-run       Preview changes without writing files
-  --help, -h      Show this help message
-`);
-}
-export function showUpdateTemplatesHelp() {
-    console.info(`
-Usage: release-kit update-templates [options]
-
-Update the GitHub Actions workflows that release-kit scaffolds to the templates
-of the installed version, showing what changed in each file. Creates a missing
-workflow that \`init\` would create, and refreshes sync-labels.yaml only when it
-exists. When every package is private, refreshes publish.yaml and
-create-github-release.yaml only when they exist. Keeps publish.yaml's provenance
-setting. Never touches config files.
-
-Options:
-  --dry-run       Preview changes without writing files
-  --help, -h      Show this help message
-`);
-}

package/dist/esm/help/overridesHelp.d.ts

@@ -1,4 +0,0 @@
-/** Prints the `overrides` command's help text. */
-export declare function showOverridesHelp(): void;
-/** Prints the `overrides validate` subcommand's help text. */
-export declare function showOverridesValidateHelp(): void;

package/dist/esm/help/overridesHelp.js

@@ -1,32 +0,0 @@
-export function showOverridesHelp() {
-    console.info(`
-Usage: release-kit overrides <subcommand> [options]
-
-Manage editorial changelog overrides.
-
-Subcommands:
-  validate      Validate every \`.meta/changelog-overrides.json\` file across all scopes
-
-Options:
-  --help, -h    Show this help message
-`);
-}
-export function showOverridesValidateHelp() {
-    console.info(`
-Usage: release-kit overrides validate
-
-Validate every \`.meta/changelog-overrides.json\` file across the project and per-workspace
-scopes. Reports schema/parse errors, ambiguous-prefix errors, conflicting-key errors, and
-stale-key warnings.
-
-Exit codes:
-  0    Clean: no errors, no stale keys
-  1    Stale-key warnings only (no errors)
-  2    Schema/parse, ambiguous-prefix, or conflicting-key errors (errors take precedence)
-
-Options:
-  --config <path>  Config file, relative to the current directory
-                   (default: .config/release-kit.config.ts at the repo root)
-  --help, -h       Show this help message
-`);
-}

package/dist/esm/help/prepareHelp.d.ts

@@ -1,7 +0,0 @@
-/**
- * Help text for `release-kit prepare`. The module does not have any import-time side effects, so that a test can
- * import it without running the CLI.
- */
-export declare const prepareHelpText = "\nUsage: release-kit prepare [options]\n\nRun release preparation with automatic workspace discovery.\n\nOptions:\n  --config <path>       Config file, relative to the current directory\n                         (default: .config/release-kit.config.ts at the repo root)\n  --dry-run             Run without modifying any files\n  --bump=major|minor|patch  Set the level of every release that happens; does not trigger one\n  --set-version=X.Y.Z   Set an explicit version; bypasses the changelog-derived bump. In monorepo\n                         mode, name each workspace or directory target:\n                         --set-version=arrays@1.0.0[,strings@2.0.0].\n                         Rejected when a composite (a 'project' block or a releases composite)\n                         is configured.\n  --force               Release even when the last tag is not followed by any commits,\n                         or by any bump-worthy ones. Defaults to patch when --bump is not given;\n                         use --bump=X for a different level.\n  --no-git-checks, -n   Skip the clean-working-tree check\n  --only=name1,name2    Release only the named release targets and their dependents\n                         (comma-separated, monorepo only). A composite declared under 'releases'\n                         releases only when named; a 'project' block's release is skipped.\n  --with-release-notes  Also write per-workspace release-notes previews under <workspacePath>/docs/\n                         (docs/README.v<version>.md and docs/RELEASE_NOTES.v<version>.md).\n                         Recommended .gitignore entry: packages/*/docs/*.v*.md (or docs/*.v*.md).\n  --help, -h            Show this help message\n";
-/** Prints the prepare command's help text. */
-export declare function showPrepareHelp(): void;

package/dist/esm/help/prepareHelp.js

@@ -1,30 +0,0 @@
-export const prepareHelpText = `
-Usage: release-kit prepare [options]
-
-Run release preparation with automatic workspace discovery.
-
-Options:
-  --config <path>       Config file, relative to the current directory
-                         (default: .config/release-kit.config.ts at the repo root)
-  --dry-run             Run without modifying any files
-  --bump=major|minor|patch  Set the level of every release that happens; does not trigger one
-  --set-version=X.Y.Z   Set an explicit version; bypasses the changelog-derived bump. In monorepo
-                         mode, name each workspace or directory target:
-                         --set-version=arrays@1.0.0[,strings@2.0.0].
-                         Rejected when a composite (a 'project' block or a releases composite)
-                         is configured.
-  --force               Release even when the last tag is not followed by any commits,
-                         or by any bump-worthy ones. Defaults to patch when --bump is not given;
-                         use --bump=X for a different level.
-  --no-git-checks, -n   Skip the clean-working-tree check
-  --only=name1,name2    Release only the named release targets and their dependents
-                         (comma-separated, monorepo only). A composite declared under 'releases'
-                         releases only when named; a 'project' block's release is skipped.
-  --with-release-notes  Also write per-workspace release-notes previews under <workspacePath>/docs/
-                         (docs/README.v<version>.md and docs/RELEASE_NOTES.v<version>.md).
-                         Recommended .gitignore entry: packages/*/docs/*.v*.md (or docs/*.v*.md).
-  --help, -h            Show this help message
-`;
-export function showPrepareHelp() {
-    console.info(prepareHelpText);
-}

package/dist/esm/help/releaseStepsHelp.d.ts

@@ -1,12 +0,0 @@
-/** Prints the `commit` command's help text. */
-export declare function showCommitHelp(): void;
-/** Prints the `create-github-release` command's help text. */
-export declare function showCreateGithubReleaseHelp(): void;
-/** Prints the `publish` command's help text. */
-export declare function showPublishHelp(): void;
-/** Prints the `push` command's help text. */
-export declare function showPushHelp(): void;
-/** Prints the `show-tag-prefixes` command's help text. */
-export declare function showShowTagPrefixesHelp(): void;
-/** Prints the `tag` command's help text. */
-export declare function showTagHelp(): void;

package/dist/esm/help/releaseStepsHelp.js

@@ -1,91 +0,0 @@
-export function showCommitHelp() {
-    console.info(`
-Usage: release-kit commit [options]
-
-Stage all changes and create the release commit using tags and summary
-produced by \`prepare\`.
-
-Options:
-  --dry-run     Preview the commit message without creating it
-  --help, -h    Show this help message
-`);
-}
-export function showCreateGithubReleaseHelp() {
-    console.info(`
-Usage: release-kit create-github-release [options]
-
-Create GitHub Releases from changelog.json for tags on HEAD. Private
-(package.json#private) workspaces are skipped with a warning, and the command
-doesn't create a Release for them. A project tag gets a Release even when the
-root package is private.
-
-Options:
-  --config <path>        Config file, relative to the current directory
-                         (default: .config/release-kit.config.ts at the repo root)
-  --dry-run              Preview without creating releases
-  --tags=tag1,tag2       Only create releases for the named tags (comma-separated, full tag names)
-  --help, -h             Show this help message
-`);
-}
-export function showPublishHelp() {
-    console.info(`
-Usage: release-kit publish [options]
-
-Publish packages that have release tags on HEAD. Operates only on workspaces whose
-package.json#private is absent or false. Without --tags, unpublishable workspaces are
-silently filtered out. With --tags, an unpublishable tag is skipped with a warning while
-any publishable tags are still published. A project tag is never published.
-
-Options:
-  --config <path>        Config file, relative to the current directory
-                         (default: .config/release-kit.config.ts at the repo root)
-  --dry-run              Preview without publishing
-  --no-git-checks        Skip the clean-working-tree check
-  --tags=tag1,tag2       Only publish the named tags (comma-separated, full tag names)
-  --provenance           Generate provenance statement (requires OIDC, not supported by classic yarn)
-  --help, -h             Show this help message
-`);
-}
-export function showPushHelp() {
-    console.info(`
-Usage: release-kit push [options]
-
-Push the release commit and each tag individually, so that GitHub Actions
-starts a separate workflow run for each tag.
-
-Options:
-  --config <path>        Config file, relative to the current directory
-                         (default: .config/release-kit.config.ts at the repo root)
-  --dry-run              Preview without pushing
-  --tags=tag1,tag2       Only push the named tags (comma-separated, full tag names)
-  --tags-only            Skip the branch push (push tags only)
-  --help, -h             Show this help message
-`);
-}
-export function showShowTagPrefixesHelp() {
-    console.info(`
-Usage: release-kit show-tag-prefixes [options]
-
-Print a per-workspace table of derived tag prefixes, tag counts, and declared
-legacy tag prefixes. Reports any release-shaped tags whose prefix is neither a
-derived prefix nor declared in \`legacyIdentities\`, with a copy-pasteable
-config snippet.
-
-Options:
-  --config <path>  Config file, relative to the current directory
-                   (default: .config/release-kit.config.ts at the repo root)
-  --help, -h       Show this help message
-`);
-}
-export function showTagHelp() {
-    console.info(`
-Usage: release-kit tag [options]
-
-Create annotated git tags from the tags file produced by \`prepare\`.
-
-Options:
-  --dry-run          Preview without creating tags
-  --no-git-checks    Skip dirty working tree check
-  --help, -h         Show this help message
-`);
-}

package/dist/esm/help/syncLabelsHelp.d.ts

@@ -1,8 +0,0 @@
-/** Prints the `sync-labels generate` subcommand's help text. */
-export declare function showSyncLabelsGenerateHelp(): void;
-/** Prints the `sync-labels` command's help text. */
-export declare function showSyncLabelsHelp(): void;
-/** Prints the `sync-labels init` subcommand's help text. */
-export declare function showSyncLabelsInitHelp(): void;
-/** Prints the `sync-labels sync` subcommand's help text. */
-export declare function showSyncLabelsSyncHelp(): void;

package/dist/esm/help/syncLabelsHelp.js

@@ -1,55 +0,0 @@
-export function showSyncLabelsGenerateHelp() {
-    console.info(`
-Usage: release-kit sync-labels generate [options]
-
-Regenerate .github/labels.yaml from the repoLabels block of .config/release-kit.config.ts.
-
-Options:
-  --check          Report whether .github/labels.yaml is stale instead of writing it
-  --config <path>  Config file, relative to the current directory
-                   (default: .config/release-kit.config.ts at the repo root)
-  --help, -h       Show this help message
-`);
-}
-export function showSyncLabelsHelp() {
-    console.info(`
-Usage: release-kit sync-labels <subcommand> [options]
-
-Manage GitHub label synchronization via preset and custom label definitions.
-
-Subcommands:
-  init          Scaffold caller workflow and config, then generate labels
-  generate      Regenerate .github/labels.yaml from config
-  sync          Trigger the sync-labels workflow via gh CLI
-
-Options:
-  --help, -h    Show this help message
-`);
-}
-export function showSyncLabelsInitHelp() {
-    console.info(`
-Usage: release-kit sync-labels init [options]
-
-Scaffold the sync-labels caller workflow and seed the repoLabels block of
-.config/release-kit.config.ts with scope labels discovered from workspaces and
-retired packages, then generate .github/labels.yaml. When the config file already
-exists, print the block for manual paste instead of rewriting the file.
-
-Options:
-  --config <path>  Config file, relative to the current directory
-                   (default: .config/release-kit.config.ts at the repo root)
-  --dry-run        Preview changes without writing files
-  --force          Overwrite existing files instead of skipping them
-  --help, -h       Show this help message
-`);
-}
-export function showSyncLabelsSyncHelp() {
-    console.info(`
-Usage: release-kit sync-labels sync
-
-Trigger the sync-labels GitHub Actions workflow via the gh CLI.
-
-Options:
-  --help, -h    Show this help message
-`);
-}

package/dist/esm/help/usage.d.ts

@@ -1,2 +0,0 @@
-/** Prints the top-level usage text. */
-export declare function showUsage(): void;

package/dist/esm/help/usage.js

@@ -1,29 +0,0 @@
-import { OUTPUT_STYLE_ENV_VAR } from "../resolveStylesOrExit.js";
-export function showUsage() {
-    console.info(`
-Usage: release-kit <command> [options]
-
-Commands:
-  prepare          Run release preparation (auto-discovers workspaces)
-  commit           Stage changes and create the release commit
-  tag              Create annotated git tags from the tags file
-  push             Push release commit and tags (one push per tag)
-  publish          Publish packages with release tags on HEAD
-  create-github-release  Create GitHub Releases from changelog.json for tags on HEAD
-  show-tag-prefixes  Show derived and declared legacy tag prefixes per workspace
-  init             Initialize release-kit in the current repository
-  update-templates Update the scaffolded workflows to the current templates
-  overrides        Manage editorial changelog overrides
-  sync-labels      Manage GitHub label synchronization
-
-Options:
-  --dry-run        Preview changes without writing files
-  --help, -h       Show this help message
-  --version, -V    Show the version number
-
-Environment:
-  ${OUTPUT_STYLE_ENV_VAR}
-                   Output style: auto (default), plain, or rich. auto prints plain,
-                   without emoji, when CI is set or the stream is not a terminal.
-`);
-}

package/dist/esm/resolveConfigFlag.d.ts

@@ -1,7 +0,0 @@
-/**
- * Resolves a `--config` value against the directory from which `release-kit` was invoked, which differs from the
- * working directory once the process has moved to the repo root.
- *
- * Returns `undefined` when the flag is absent, so that `loadConfig` falls back to the default path under the root.
- */
-export declare function resolveConfigFlag(config: string | undefined, invocationDir: string): string | undefined;

package/dist/esm/resolveConfigFlag.js

@@ -1,4 +0,0 @@
-import path from 'node:path';
-export function resolveConfigFlag(config, invocationDir) {
-    return config === undefined ? undefined : path.resolve(invocationDir, config);
-}

package/dist/esm/resolveStylesOrExit.js

@@ -1,10 +0,0 @@
-import { describeInvalidOutputStyle, reportError, resolveStreamStyles, } from '@williamthorsen/nmr-core';
-export const OUTPUT_STYLE_ENV_VAR = 'RELEASE_KIT_OUTPUT_STYLE';
-export function resolveStylesOrExit(options) {
-    const { invalid, styles } = resolveStreamStyles({ ...options, envVar: OUTPUT_STYLE_ENV_VAR });
-    if (invalid !== undefined) {
-        reportError(describeInvalidOutputStyle(invalid));
-        process.exit(1);
-    }
-    return styles;
-}

package/dist/esm/runCli.d.ts

@@ -1,5 +0,0 @@
-/**
- * Dispatches the `release-kit` command named by `args[0]`. A command exits the process itself; a failure that it throws
- * propagates to the caller.
- */
-export declare function runCli(args: string[]): Promise<void>;