@williamthorsen/release-kit 10.8.0 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.meta/changelog.json +100 -3
- package/.readyup/kits/default.js +3 -3
- package/.readyup/kits/npm-auto-publish.js +43 -23
- package/.readyup/manifest.json +9 -9
- package/CHANGELOG.md +82 -3
- package/README.md +46 -11
- package/dist/esm/bin/release-kit.js +46 -120
- package/dist/esm/buildChangelogEntries.js +1 -0
- package/dist/esm/configFlagSchema.d.ts +12 -0
- package/dist/esm/configFlagSchema.js +3 -0
- package/dist/esm/createGithubReleaseCommand.d.ts +2 -1
- package/dist/esm/createGithubReleaseCommand.js +9 -3
- package/dist/esm/createTags.d.ts +2 -0
- package/dist/esm/createTags.js +5 -4
- package/dist/esm/discoverWorkspaces.d.ts +53 -8
- package/dist/esm/discoverWorkspaces.js +57 -37
- package/dist/esm/format.d.ts +5 -5
- package/dist/esm/format.js +5 -4
- package/dist/esm/glyphs.d.ts +3 -0
- package/dist/esm/glyphs.js +6 -0
- package/dist/esm/help/prepareHelp.d.ts +1 -1
- package/dist/esm/help/prepareHelp.js +1 -0
- package/dist/esm/init/initCommand.d.ts +3 -1
- package/dist/esm/init/initCommand.js +15 -15
- package/dist/esm/loadConfig.d.ts +7 -4
- package/dist/esm/loadConfig.js +6 -3
- package/dist/esm/loadValidatedConfig.d.ts +47 -5
- package/dist/esm/loadValidatedConfig.js +32 -15
- package/dist/esm/prepareCommand.d.ts +7 -1
- package/dist/esm/prepareCommand.js +37 -45
- package/dist/esm/previewTagPrefixes.d.ts +9 -6
- package/dist/esm/previewTagPrefixes.js +12 -24
- package/dist/esm/publishCommand.d.ts +4 -3
- package/dist/esm/publishCommand.js +9 -3
- package/dist/esm/pushCommand.d.ts +1 -1
- package/dist/esm/pushCommand.js +2 -2
- package/dist/esm/reportPrepare.d.ts +2 -0
- package/dist/esm/reportPrepare.js +51 -41
- package/dist/esm/resolveCommandTags.d.ts +3 -2
- package/dist/esm/resolveCommandTags.js +10 -6
- package/dist/esm/resolveReleaseNotesConfig.d.ts +10 -11
- package/dist/esm/resolveReleaseNotesConfig.js +10 -29
- package/dist/esm/resolveStylesOrExit.d.ts +10 -0
- package/dist/esm/resolveStylesOrExit.js +10 -0
- package/dist/esm/showTagPrefixesCommand.d.ts +5 -2
- package/dist/esm/showTagPrefixesCommand.js +31 -11
- package/dist/esm/sync-labels/generateCommand.d.ts +18 -8
- package/dist/esm/sync-labels/generateCommand.js +12 -11
- package/dist/esm/sync-labels/initCommand.d.ts +11 -4
- package/dist/esm/sync-labels/initCommand.js +24 -18
- package/dist/esm/sync-labels/retiredConfig.d.ts +4 -2
- package/dist/esm/sync-labels/retiredConfig.js +2 -2
- package/dist/esm/tagCommand.d.ts +2 -1
- package/dist/esm/tagCommand.js +2 -2
- package/dist/esm/validateOverridesCommand.d.ts +13 -7
- package/dist/esm/validateOverridesCommand.js +28 -36
- package/docs/configuration.md +35 -1
- package/docs/labels.md +2 -0
- package/docs/work-types.md +11 -8
- package/package.json +13 -14
- package/presets/labels/common.yaml +2 -2
- package/dist/esm/checkWorkTypesDrift.d.ts +0 -35
- package/dist/esm/checkWorkTypesDrift.js +0 -117
- package/dist/esm/syncWorkTypes.d.ts +0 -28
- package/dist/esm/syncWorkTypes.js +0 -94
- package/dist/esm/work-types.json +0 -149
- package/dist/esm/work-types.schema.json +0 -110
- package/dist/esm/workTypesUtils.d.ts +0 -22
- package/dist/esm/workTypesUtils.js +0 -16
package/.meta/changelog.json
CHANGED
|
@@ -1,4 +1,104 @@
|
|
|
1
1
|
[
|
|
2
|
+
{
|
|
3
|
+
"version": "11.0.0",
|
|
4
|
+
"date": "2026-09-22",
|
|
5
|
+
"sections": [
|
|
6
|
+
{
|
|
7
|
+
"title": "🎉 Features",
|
|
8
|
+
"audience": "all",
|
|
9
|
+
"items": [
|
|
10
|
+
{
|
|
11
|
+
"description": "Return the provenance check's remediation as the outcome's fix (#855)",
|
|
12
|
+
"body": "- Moves the remediation of the `npm-auto-publish` kit's `Provenance setting matches repo visibility` check from the failing outcome's `detail` into its `fix`, so that readyup marks it as a remedy, lists it in the `Fixes` recap, and reports it under `rdy run --json --detail summary` instead of printing it as a plain reason line.\n- Declares `minReadyupVersion: '0.37.0'` on the kit, the readyup release that introduced `CheckOutcome.fix`, which retires the kit's `version-skew` advisory and makes an older runner fail to load the kit.\n\nMigration: Upgrade readyup to 0.37.0 or later before consuming this release of the `npm-auto-publish` kit.",
|
|
13
|
+
"breaking": true,
|
|
14
|
+
"migration": "Upgrade readyup to 0.37.0 or later before consuming this release of the `npm-auto-publish` kit.",
|
|
15
|
+
"hash": "2455edc46611a47e95707f79cdebda539a844431"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"description": "Accept a --config argument on every config-reading subcommand (#857)",
|
|
19
|
+
"body": "- Adds `--config <path>` to `prepare`, `publish`, `create-github-release`, `show-tag-prefixes`, `overrides validate`, `sync-labels init`, and `sync-labels generate`, each of which then reads the named file in place of `.config/release-kit.config.ts`.\n- Requires a named `--config` file to exist, failing if it does not; an absent default path continues to mean that the repo declares no config.\n- Confines scaffolding to the default path: `release-kit init` and `sync-labels init` still write `.config/release-kit.config.ts`, and `sync-labels init --config` reads the named file and fails when it is absent.",
|
|
20
|
+
"hash": "f605a6fd7e48b27b17fb90bad161f4507979e5aa"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"description": "Adopt the shared workspace resolver in release-kit, honoring exclusions (#865)",
|
|
24
|
+
"body": "- 🚨 **Breaking:** Narrows `no-pattern` in `@williamthorsen/nmr-core`'s `EmptyWorkspaceCause`, moving an absent or empty `packages` list onto `no-packages-list` and a value that is not a list of strings onto `unreadable-packages`.\n- Stops `release-kit` from tagging, publishing, and label-syncing a package that a `!` entry in `pnpm-workspace.yaml` excludes, which its previous `glob`-based resolution could not remove from the match.\n- Replaces the release of the root package alone with a failure naming the condition that emptied the workspace, when `pnpm-workspace.yaml` does not hold valid YAML or declares a workspace that does not resolve to a package.\n- Replaces the `no-pattern` remedy that `nmr` printed for a `pnpm-workspace.yaml` declaring no `packages` list, and for one declaring a `packages` value that is not a list of strings.\n- Raises `engines.node` to `>=24.16.0` in `@williamthorsen/nmr-core` and `@williamthorsen/release-kit`, because Node 24.0 through 24.15 ignores the `followSymlinks` option that the workspace matcher passes to `globSync` and drops a symlinked package directory from the resolution without reporting it.\n\nMigration: Add a `no-packages-list` arm and an `unreadable-packages` arm to any `switch` that covers `EmptyWorkspaceCause` exhaustively. `no-pattern` now names only a list that the resolver read in full and whose entries all failed to become a positive pattern, so move the handling of an absent `packages` key, an empty list, and a value that is not a list of strings out of the `no-pattern` arm into the two new ones. Route `no-packages-list` to single-package behavior rather than to a failure path: pnpm resolves such a manifest to the root package alone.",
|
|
25
|
+
"breaking": true,
|
|
26
|
+
"migration": "Add a `no-packages-list` arm and an `unreadable-packages` arm to any `switch` that covers `EmptyWorkspaceCause` exhaustively. `no-pattern` now names only a list that the resolver read in full and whose entries all failed to become a positive pattern, so move the handling of an absent `packages` key, an empty list, and a value that is not a list of strings out of the `no-pattern` arm into the two new ones. Route `no-packages-list` to single-package behavior rather than to a failure path: pnpm resolves such a manifest to the root package alone.",
|
|
27
|
+
"hash": "b1126866159402b8f027a9b82f2a19591a6e9e1b"
|
|
28
|
+
}
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"title": "🐛 Bug fixes",
|
|
33
|
+
"audience": "all",
|
|
34
|
+
"items": [
|
|
35
|
+
{
|
|
36
|
+
"description": "Truncate release-kit commit subjects by display column (#840)",
|
|
37
|
+
"body": "- Fixes the issue that the `release-kit` prepare report cut a commit subject at 69 UTF-16 code units instead of at display columns, so a subject of CJK characters printed about twice the intended 72-column width and a cut inside an emoji left a broken character that a terminal drew as a replacement glyph.\n- Replaces the `...` marker on a truncated subject with `…`, the default of the width-aware truncation that now does the cutting.\n- Exports `truncateToWidth` and `measureWidth` from `@williamthorsen/nmr-core`, which measure and cut text by display width without splitting a grapheme cluster.",
|
|
38
|
+
"hash": "f75d9b4abd9fbda264d5dd40ca5b7abb64f5a3f3"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"description": "Abort show-tag-prefixes on an unusable config (#861)",
|
|
42
|
+
"body": "- Fixes the issue that `release-kit show-tag-prefixes` silently ignored a config file that failed schema validation, which left the preview reading no `legacyIdentities` and no `retiredPackages` and reporting already-declared and retired tag prefixes as undeclared candidates; the command now prints those validation errors and exits 1 with no preview.",
|
|
43
|
+
"hash": "2177873d9a79247385e5a1f09e95971449488d9f"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"description": "Abort every config-reading command on an unusable default config (#869)",
|
|
47
|
+
"body": "- Fixes `publish` proceeding on derived defaults when the default config file exists and fails to load, which silently dropped a configured `releaseNotes.shouldInjectIntoReadme`, `changelogJson.outputPath`, or `workTypes`; it now reports the failure and exits 1, as every other config-reading subcommand does.\n- Fixes `publish` and `create-github-release` ignoring a broken or invalid default config when every requested tag names a private package, a case in which both commands return before any loader runs.",
|
|
48
|
+
"hash": "5b2873f2b9b7e42f1011d90506ca7ea6945d09a1"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"description": "Strip trailing Change trailers from changelog item bodies (#870)",
|
|
52
|
+
"body": "- Fixes a changelog item body that kept a commit's trailing `Change:` trailers, which then appeared verbatim in the rendered release notes, including the notes injected into a README.",
|
|
53
|
+
"hash": "250e52b3a2947202e3a7246fb39ebcb79e2bd1fc"
|
|
54
|
+
}
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"version": "10.9.0",
|
|
61
|
+
"date": "2026-09-18",
|
|
62
|
+
"sections": [
|
|
63
|
+
{
|
|
64
|
+
"title": "🎉 Features",
|
|
65
|
+
"audience": "all",
|
|
66
|
+
"items": [
|
|
67
|
+
{
|
|
68
|
+
"description": "Give release-kit plain output in pipes and CI logs (#835)",
|
|
69
|
+
"body": "- Adds the `RELEASE_KIT_OUTPUT_STYLE` environment variable, which accepts `auto`, `plain`, or `rich` and outranks the detection from `CI`, the stream's terminal state, and `TERM`; any other value is a usage error that exits with code 1.\n- Changes the emoji in rich output so that none has a different meaning from the one that it has in `nmr`: warnings from ⚠️ to 🟠, skips from ⏭️ to ⏩, the errors of `show-tag-prefixes` from ⛔ to ❌, and the tag marker from 🏷️ to 🔖.\n- Adds a required `style` parameter to `formatValidateOverridesResult`, which the package root exports.",
|
|
70
|
+
"hash": "aae401b4bbcafc7014e4b3804d80528d2d098a30"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"description": "Give nmr plain output in pipes and CI logs (#838)",
|
|
74
|
+
"body": "- Stops `nmr` from printing emoji to a pipe or a CI log: When the output stream is not a terminal or `CI` is set, a verdict reads `PASS`, `FAIL`, `SKIP`, or `NOOP` and a command icon is omitted, so that a log can be searched for a verdict.\n- Adds `--output-style <auto|plain|rich>` to `nmr` and the `NMR_OUTPUT_STYLE` variable, each forcing either style; the flag outranks the variable, a value that names no style exits 1 with a usage error, and neither enters a check-cache key: A rich run and a plain run share a recorded pass.\n- Replaces several rich glyphs, taking the status markers from the set that release-kit and v11y-check print so that one status has one glyph across the three tools: a recalled pass shows ⏩ in place of ⏭️, a skipped empty override shows ⚪ in place of ⛔, a warning and the `--log` refusal show 🟠 in place of ⚠️ and 📭, the `--log` header shows 💾 in place of 📼, and `nmr-ensure-prepublish-hooks` reports ✅ and ❌ in place of ✓ and ✗.",
|
|
75
|
+
"hash": "693b3a7f57def3d299ced240c19bda90f6253bdc"
|
|
76
|
+
}
|
|
77
|
+
]
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"title": "🐛 Bug fixes",
|
|
81
|
+
"audience": "all",
|
|
82
|
+
"items": [
|
|
83
|
+
{
|
|
84
|
+
"description": "Move work-types check and sync from the CLI into maintainer scripts (#820)",
|
|
85
|
+
"body": "- Removes the `release-kit work-types` command, whose `sync` rewrote an unused copy of `work-types.json` inside `node_modules` and whose `check` reported drift that a consumer could not fix.",
|
|
86
|
+
"hash": "31db5888038d69369422fdabbb1cc411dc95d6e1"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"description": "Exclude distributed agent guidance from ai and documentation labels (#825)",
|
|
90
|
+
"body": "- Marks a `.github/labels.yaml` generated from the previous `common` preset as stale in the default readyup kit, whose \"labels.yaml has current common preset\" check reports the file until the repo regenerates it.",
|
|
91
|
+
"hash": "0c4b0c59d8d87cdee66257ea7ca1bf9be86ce017"
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"description": "Suppress bold and dim escapes for a stream that cannot render them (#830)",
|
|
95
|
+
"body": "- Stops `release-kit prepare` from writing raw escape bytes into piped output, redirected files, and CI logs: It styled bold and dim unconditionally, without checking whether the destination renders escapes.\n- Honors `NO_COLOR`, `NODE_DISABLE_COLORS`, and `FORCE_COLOR`, which the previous styling ignored.",
|
|
96
|
+
"hash": "eee5717f231615f9330c43239279d46d2a77a262"
|
|
97
|
+
}
|
|
98
|
+
]
|
|
99
|
+
}
|
|
100
|
+
]
|
|
101
|
+
},
|
|
2
102
|
{
|
|
3
103
|
"version": "10.8.0",
|
|
4
104
|
"date": "2026-09-15",
|
|
@@ -537,7 +637,6 @@
|
|
|
537
637
|
{
|
|
538
638
|
"description": "Move defineConfig to a dedicated config subpath (#566)",
|
|
539
639
|
"body": "`defineConfig` now comes from the `@williamthorsen/release-kit/config` subpath rather than from the package root. The subpath also carries the config types.",
|
|
540
|
-
"breaking": true,
|
|
541
640
|
"hash": "e0769815f41c23d64302be26c8369209fad72e22"
|
|
542
641
|
},
|
|
543
642
|
{
|
|
@@ -1134,13 +1233,11 @@
|
|
|
1134
1233
|
{
|
|
1135
1234
|
"description": "Rename `component` to `workspace` in config API and internals (#296)",
|
|
1136
1235
|
"body": "Renames release-kit's per-workspace vocabulary from \"component\" to \"workspace\" throughout the public API, internal types, validation messages, CLI help, init templates, and documentation. Behavior is unchanged; only identifiers, error-message strings, scaffolded template text, and prose have been changed.",
|
|
1137
|
-
"breaking": true,
|
|
1138
1236
|
"hash": "dfe0a70903997b85a2ebf57a612345be5232a2c6"
|
|
1139
1237
|
},
|
|
1140
1238
|
{
|
|
1141
1239
|
"description": "Rename `node-monorepo-core` to `nmr-core` (#304)",
|
|
1142
1240
|
"body": "Renames the shared-utilities package from `@williamthorsen/node-monorepo-core` to `@williamthorsen/nmr-core`, aligning it with the repository's `nmr-*` naming convention. The package's functionality and version are unchanged; only the published name differs.",
|
|
1143
|
-
"breaking": true,
|
|
1144
1241
|
"hash": "085d4a57d1828bcd33933652aa47423989c090a9"
|
|
1145
1242
|
}
|
|
1146
1243
|
]
|
package/.readyup/kits/default.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/** @noformat -- @generated. Do not edit. Compiled by rdy. */
|
|
2
2
|
/* eslint-disable */
|
|
3
|
-
export const __readyupVersion = "0.
|
|
3
|
+
export const __readyupVersion = "0.38.0";
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
// .readyup/kits/default.ts
|
|
@@ -98,7 +98,7 @@ function translateGlob(pattern) {
|
|
|
98
98
|
|
|
99
99
|
// .readyup/kits/default.ts
|
|
100
100
|
function getMinVersion() {
|
|
101
|
-
const picked = { "version": "
|
|
101
|
+
const picked = { "version": "11.0.0" };
|
|
102
102
|
if (typeof picked["version"] !== "string") {
|
|
103
103
|
throw new TypeError("release-kit/package.json: 'version' must be a string");
|
|
104
104
|
}
|
|
@@ -115,7 +115,7 @@ var CONFIG_EXPORT_PATTERNS = [
|
|
|
115
115
|
/export\s*\*/
|
|
116
116
|
];
|
|
117
117
|
var CLIFF_TEMPLATE_HASH = "93b72e0b1393cd6b1fe8e2a0e303cd326fd323435951b0493396b305af32d2ec";
|
|
118
|
-
var COMMON_PRESET_HASH = "
|
|
118
|
+
var COMMON_PRESET_HASH = "8c52654d4eee216c22377dd1e65b89f6bbb0a3478d74379bd28b04a877f0b02a";
|
|
119
119
|
var SYNC_LABELS_WORKFLOW_HASH = "d6e2403fb551d2d415f679125989c92760444eec887644565b2e05c9bf8f4c1e";
|
|
120
120
|
var RELEASE_WORKFLOW_HASH_MONOREPO = "0a9724b7b3c5e24087fd3a8f36fed8e990d699267fcf36028ce048ab40dc2946";
|
|
121
121
|
var RELEASE_WORKFLOW_HASH_SINGLE = "a3d19bbc1ba8bb30622e53c590137b97e3179e80988c0967737b021cdaeab73f";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/** @noformat -- @generated. Do not edit. Compiled by rdy. */
|
|
2
2
|
/* eslint-disable */
|
|
3
|
-
export const __readyupVersion = "0.
|
|
3
|
+
export const __readyupVersion = "0.38.0";
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
// .readyup/kits/npm-auto-publish.ts
|
|
@@ -94,6 +94,9 @@ var packagesChecklist = defineRdyChecklist({
|
|
|
94
94
|
});
|
|
95
95
|
var npm_auto_publish_default = defineRdyKit({
|
|
96
96
|
fixLocation: "inline",
|
|
97
|
+
// The release that introduced `CheckOutcome.fix`, on which the provenance check's remediation depends. An older
|
|
98
|
+
// runner drops that `fix` silently, so failing to load the kit is the lesser harm.
|
|
99
|
+
minReadyupVersion: "0.37.0",
|
|
97
100
|
checklists: [repoChecklist, packagesChecklist]
|
|
98
101
|
});
|
|
99
102
|
function belongsInPackagesChecklist(workspace) {
|
|
@@ -107,8 +110,8 @@ function buildSessionCheck() {
|
|
|
107
110
|
const capability = getCachedTrustCapability();
|
|
108
111
|
return capability.ok ? { ok: true } : { ok: false, detail: capability.detail };
|
|
109
112
|
},
|
|
110
|
-
// A plain string rather than a getter, because
|
|
111
|
-
//
|
|
113
|
+
// A plain string rather than a getter, because the remediation is the same however the session fails; only
|
|
114
|
+
// the `detail` above varies.
|
|
112
115
|
fix: 'Restore a usable npm session: log in with "npm login", supplying the one-time password when prompted, or restore access to the registry, which the trusted-publisher check queries directly'
|
|
113
116
|
};
|
|
114
117
|
}
|
|
@@ -175,29 +178,13 @@ function buildWorkspaceCheck(workspace) {
|
|
|
175
178
|
function checkProvenanceMatchesVisibility() {
|
|
176
179
|
const workflowPath = ".github/workflows/publish.yaml";
|
|
177
180
|
const content = readFile(workflowPath);
|
|
178
|
-
|
|
179
|
-
return { ok: false, detail: `Cannot read ${workflowPath} \u2014 check file permissions` };
|
|
180
|
-
}
|
|
181
|
-
const hasProvenance = parseProvenanceSetting(content);
|
|
182
|
-
let isPrivate;
|
|
181
|
+
let visibility;
|
|
183
182
|
try {
|
|
184
|
-
|
|
183
|
+
visibility = isRepoPrivate() ? "private" : "public";
|
|
185
184
|
} catch {
|
|
186
|
-
|
|
187
|
-
}
|
|
188
|
-
if (!isPrivate && !hasProvenance) {
|
|
189
|
-
return {
|
|
190
|
-
ok: false,
|
|
191
|
-
detail: "Set provenance: true in .github/workflows/publish.yaml \u2014 public repos should generate provenance attestations"
|
|
192
|
-
};
|
|
193
|
-
}
|
|
194
|
-
if (isPrivate && hasProvenance) {
|
|
195
|
-
return {
|
|
196
|
-
ok: false,
|
|
197
|
-
detail: "Make the GitHub repo public \u2014 OIDC publishing with provenance requires a public repo"
|
|
198
|
-
};
|
|
185
|
+
visibility = "unknown";
|
|
199
186
|
}
|
|
200
|
-
return
|
|
187
|
+
return classifyProvenanceSetting(content, visibility);
|
|
201
188
|
}
|
|
202
189
|
function checkTrustedPublisher(packageName) {
|
|
203
190
|
const result = getTrustQueryResult(packageName);
|
|
@@ -226,6 +213,38 @@ function classifyNpmAuth(result) {
|
|
|
226
213
|
}
|
|
227
214
|
return { status: "unreachable", detail: `The npm registry query failed (${error.code}): ${error.summary}` };
|
|
228
215
|
}
|
|
216
|
+
function classifyProvenanceSetting(workflowContent, visibility) {
|
|
217
|
+
if (workflowContent === void 0) {
|
|
218
|
+
return {
|
|
219
|
+
ok: false,
|
|
220
|
+
detail: "Cannot read .github/workflows/publish.yaml",
|
|
221
|
+
fix: "Check the file's permissions"
|
|
222
|
+
};
|
|
223
|
+
}
|
|
224
|
+
if (visibility === "unknown") {
|
|
225
|
+
return {
|
|
226
|
+
ok: false,
|
|
227
|
+
detail: "The GitHub CLI could not report the repo's visibility",
|
|
228
|
+
fix: "Install and authenticate the GitHub CLI: gh auth login"
|
|
229
|
+
};
|
|
230
|
+
}
|
|
231
|
+
const hasProvenance = parseProvenanceSetting(workflowContent);
|
|
232
|
+
if (visibility === "public" && !hasProvenance) {
|
|
233
|
+
return {
|
|
234
|
+
ok: false,
|
|
235
|
+
detail: "The repo is public and publish.yaml does not set provenance: true",
|
|
236
|
+
fix: "Set provenance: true in .github/workflows/publish.yaml \u2014 public repos should generate provenance attestations"
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
if (visibility === "private" && hasProvenance) {
|
|
240
|
+
return {
|
|
241
|
+
ok: false,
|
|
242
|
+
detail: "The repo is private and publish.yaml sets provenance: true",
|
|
243
|
+
fix: "Make the GitHub repo public \u2014 OIDC publishing with provenance requires a public repo"
|
|
244
|
+
};
|
|
245
|
+
}
|
|
246
|
+
return { ok: true };
|
|
247
|
+
}
|
|
229
248
|
function classifyTrustCapability(auth, probe) {
|
|
230
249
|
if (auth.status !== "authenticated") {
|
|
231
250
|
return { ok: false, detail: auth.detail };
|
|
@@ -409,6 +428,7 @@ function skipIfNotPublishable(workspace) {
|
|
|
409
428
|
export {
|
|
410
429
|
buildWorkspaceCheck,
|
|
411
430
|
classifyNpmAuth,
|
|
431
|
+
classifyProvenanceSetting,
|
|
412
432
|
classifyTrustCapability,
|
|
413
433
|
classifyTrustQuery,
|
|
414
434
|
npm_auto_publish_default as default,
|
package/.readyup/manifest.json
CHANGED
|
@@ -8,12 +8,12 @@
|
|
|
8
8
|
"esbuildVersion": "0.28.2",
|
|
9
9
|
"inputs": [
|
|
10
10
|
{
|
|
11
|
-
"hash": "
|
|
11
|
+
"hash": "a20ce64b",
|
|
12
12
|
"kind": "module",
|
|
13
13
|
"path": "kits/default.ts"
|
|
14
14
|
},
|
|
15
15
|
{
|
|
16
|
-
"hash": "
|
|
16
|
+
"hash": "e9aadbb2",
|
|
17
17
|
"kind": "inline",
|
|
18
18
|
"path": "../package.json",
|
|
19
19
|
"paths": [
|
|
@@ -43,10 +43,10 @@
|
|
|
43
43
|
],
|
|
44
44
|
"name": "default",
|
|
45
45
|
"path": "kits/default.js",
|
|
46
|
-
"readyupVersion": "0.
|
|
46
|
+
"readyupVersion": "0.38.0",
|
|
47
47
|
"source": "kits/default.ts",
|
|
48
|
-
"sourceHash": "
|
|
49
|
-
"targetHash": "
|
|
48
|
+
"sourceHash": "a20ce64b",
|
|
49
|
+
"targetHash": "b3fd135a"
|
|
50
50
|
},
|
|
51
51
|
{
|
|
52
52
|
"checklists": [
|
|
@@ -56,17 +56,17 @@
|
|
|
56
56
|
"esbuildVersion": "0.28.2",
|
|
57
57
|
"inputs": [
|
|
58
58
|
{
|
|
59
|
-
"hash": "
|
|
59
|
+
"hash": "c2d2d375",
|
|
60
60
|
"kind": "module",
|
|
61
61
|
"path": "kits/npm-auto-publish.ts"
|
|
62
62
|
}
|
|
63
63
|
],
|
|
64
64
|
"name": "npm-auto-publish",
|
|
65
65
|
"path": "kits/npm-auto-publish.js",
|
|
66
|
-
"readyupVersion": "0.
|
|
66
|
+
"readyupVersion": "0.38.0",
|
|
67
67
|
"source": "kits/npm-auto-publish.ts",
|
|
68
|
-
"sourceHash": "
|
|
69
|
-
"targetHash": "
|
|
68
|
+
"sourceHash": "c2d2d375",
|
|
69
|
+
"targetHash": "9d2d224b"
|
|
70
70
|
}
|
|
71
71
|
]
|
|
72
72
|
}
|
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,85 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## 11.0.0 — 2026-09-22
|
|
6
|
+
|
|
7
|
+
### 🎉 Features
|
|
8
|
+
|
|
9
|
+
- 🚨 **Breaking:** Return the provenance check's remediation as the outcome's fix (#855)
|
|
10
|
+
|
|
11
|
+
- Moves the remediation of the `npm-auto-publish` kit's `Provenance setting matches repo visibility` check from the failing outcome's `detail` into its `fix`, so that readyup marks it as a remedy, lists it in the `Fixes` recap, and reports it under `rdy run --json --detail summary` instead of printing it as a plain reason line.
|
|
12
|
+
- Declares `minReadyupVersion: '0.37.0'` on the kit, the readyup release that introduced `CheckOutcome.fix`, which retires the kit's `version-skew` advisory and makes an older runner fail to load the kit.
|
|
13
|
+
|
|
14
|
+
Migration: Upgrade readyup to 0.37.0 or later before consuming this release of the `npm-auto-publish` kit.
|
|
15
|
+
|
|
16
|
+
- Accept a --config argument on every config-reading subcommand (#857)
|
|
17
|
+
|
|
18
|
+
- Adds `--config <path>` to `prepare`, `publish`, `create-github-release`, `show-tag-prefixes`, `overrides validate`, `sync-labels init`, and `sync-labels generate`, each of which then reads the named file in place of `.config/release-kit.config.ts`.
|
|
19
|
+
- Requires a named `--config` file to exist, failing if it does not; an absent default path continues to mean that the repo declares no config.
|
|
20
|
+
- Confines scaffolding to the default path: `release-kit init` and `sync-labels init` still write `.config/release-kit.config.ts`, and `sync-labels init --config` reads the named file and fails when it is absent.
|
|
21
|
+
|
|
22
|
+
- 🚨 **Breaking:** Adopt the shared workspace resolver in release-kit, honoring exclusions (#865)
|
|
23
|
+
|
|
24
|
+
- 🚨 **Breaking:** Narrows `no-pattern` in `@williamthorsen/nmr-core`'s `EmptyWorkspaceCause`, moving an absent or empty `packages` list onto `no-packages-list` and a value that is not a list of strings onto `unreadable-packages`.
|
|
25
|
+
- Stops `release-kit` from tagging, publishing, and label-syncing a package that a `!` entry in `pnpm-workspace.yaml` excludes, which its previous `glob`-based resolution could not remove from the match.
|
|
26
|
+
- Replaces the release of the root package alone with a failure naming the condition that emptied the workspace, when `pnpm-workspace.yaml` does not hold valid YAML or declares a workspace that does not resolve to a package.
|
|
27
|
+
- Replaces the `no-pattern` remedy that `nmr` printed for a `pnpm-workspace.yaml` declaring no `packages` list, and for one declaring a `packages` value that is not a list of strings.
|
|
28
|
+
- Raises `engines.node` to `>=24.16.0` in `@williamthorsen/nmr-core` and `@williamthorsen/release-kit`, because Node 24.0 through 24.15 ignores the `followSymlinks` option that the workspace matcher passes to `globSync` and drops a symlinked package directory from the resolution without reporting it.
|
|
29
|
+
|
|
30
|
+
Migration: Add a `no-packages-list` arm and an `unreadable-packages` arm to any `switch` that covers `EmptyWorkspaceCause` exhaustively. `no-pattern` now names only a list that the resolver read in full and whose entries all failed to become a positive pattern, so move the handling of an absent `packages` key, an empty list, and a value that is not a list of strings out of the `no-pattern` arm into the two new ones. Route `no-packages-list` to single-package behavior rather than to a failure path: pnpm resolves such a manifest to the root package alone.
|
|
31
|
+
|
|
32
|
+
### 🐛 Bug fixes
|
|
33
|
+
|
|
34
|
+
- Truncate release-kit commit subjects by display column (#840)
|
|
35
|
+
|
|
36
|
+
- Fixes the issue that the `release-kit` prepare report cut a commit subject at 69 UTF-16 code units instead of at display columns, so a subject of CJK characters printed about twice the intended 72-column width and a cut inside an emoji left a broken character that a terminal drew as a replacement glyph.
|
|
37
|
+
- Replaces the `...` marker on a truncated subject with `…`, the default of the width-aware truncation that now does the cutting.
|
|
38
|
+
- Exports `truncateToWidth` and `measureWidth` from `@williamthorsen/nmr-core`, which measure and cut text by display width without splitting a grapheme cluster.
|
|
39
|
+
|
|
40
|
+
- Abort show-tag-prefixes on an unusable config (#861)
|
|
41
|
+
|
|
42
|
+
- Fixes the issue that `release-kit show-tag-prefixes` silently ignored a config file that failed schema validation, which left the preview reading no `legacyIdentities` and no `retiredPackages` and reporting already-declared and retired tag prefixes as undeclared candidates; the command now prints those validation errors and exits 1 with no preview.
|
|
43
|
+
|
|
44
|
+
- Abort every config-reading command on an unusable default config (#869)
|
|
45
|
+
|
|
46
|
+
- Fixes `publish` proceeding on derived defaults when the default config file exists and fails to load, which silently dropped a configured `releaseNotes.shouldInjectIntoReadme`, `changelogJson.outputPath`, or `workTypes`; it now reports the failure and exits 1, as every other config-reading subcommand does.
|
|
47
|
+
- Fixes `publish` and `create-github-release` ignoring a broken or invalid default config when every requested tag names a private package, a case in which both commands return before any loader runs.
|
|
48
|
+
|
|
49
|
+
- Strip trailing Change trailers from changelog item bodies (#870)
|
|
50
|
+
|
|
51
|
+
- Fixes a changelog item body that kept a commit's trailing `Change:` trailers, which then appeared verbatim in the rendered release notes, including the notes injected into a README.
|
|
52
|
+
|
|
53
|
+
## 10.9.0 — 2026-09-18
|
|
54
|
+
|
|
55
|
+
### 🎉 Features
|
|
56
|
+
|
|
57
|
+
- Give release-kit plain output in pipes and CI logs (#835)
|
|
58
|
+
|
|
59
|
+
- Adds the `RELEASE_KIT_OUTPUT_STYLE` environment variable, which accepts `auto`, `plain`, or `rich` and outranks the detection from `CI`, the stream's terminal state, and `TERM`; any other value is a usage error that exits with code 1.
|
|
60
|
+
- Changes the emoji in rich output so that none has a different meaning from the one that it has in `nmr`: warnings from ⚠️ to 🟠, skips from ⏭️ to ⏩, the errors of `show-tag-prefixes` from ⛔ to ❌, and the tag marker from 🏷️ to 🔖.
|
|
61
|
+
- Adds a required `style` parameter to `formatValidateOverridesResult`, which the package root exports.
|
|
62
|
+
|
|
63
|
+
- Give nmr plain output in pipes and CI logs (#838)
|
|
64
|
+
|
|
65
|
+
- Stops `nmr` from printing emoji to a pipe or a CI log: When the output stream is not a terminal or `CI` is set, a verdict reads `PASS`, `FAIL`, `SKIP`, or `NOOP` and a command icon is omitted, so that a log can be searched for a verdict.
|
|
66
|
+
- Adds `--output-style <auto|plain|rich>` to `nmr` and the `NMR_OUTPUT_STYLE` variable, each forcing either style; the flag outranks the variable, a value that names no style exits 1 with a usage error, and neither enters a check-cache key: A rich run and a plain run share a recorded pass.
|
|
67
|
+
- Replaces several rich glyphs, taking the status markers from the set that release-kit and v11y-check print so that one status has one glyph across the three tools: a recalled pass shows ⏩ in place of ⏭️, a skipped empty override shows ⚪ in place of ⛔, a warning and the `--log` refusal show 🟠 in place of ⚠️ and 📭, the `--log` header shows 💾 in place of 📼, and `nmr-ensure-prepublish-hooks` reports ✅ and ❌ in place of ✓ and ✗.
|
|
68
|
+
|
|
69
|
+
### 🐛 Bug fixes
|
|
70
|
+
|
|
71
|
+
- Move work-types check and sync from the CLI into maintainer scripts (#820)
|
|
72
|
+
|
|
73
|
+
- Removes the `release-kit work-types` command, whose `sync` rewrote an unused copy of `work-types.json` inside `node_modules` and whose `check` reported drift that a consumer could not fix.
|
|
74
|
+
|
|
75
|
+
- Exclude distributed agent guidance from ai and documentation labels (#825)
|
|
76
|
+
|
|
77
|
+
- Marks a `.github/labels.yaml` generated from the previous `common` preset as stale in the default readyup kit, whose "labels.yaml has current common preset" check reports the file until the repo regenerates it.
|
|
78
|
+
|
|
79
|
+
- Suppress bold and dim escapes for a stream that cannot render them (#830)
|
|
80
|
+
|
|
81
|
+
- Stops `release-kit prepare` from writing raw escape bytes into piped output, redirected files, and CI logs: It styled bold and dim unconditionally, without checking whether the destination renders escapes.
|
|
82
|
+
- Honors `NO_COLOR`, `NODE_DISABLE_COLORS`, and `FORCE_COLOR`, which the previous styling ignored.
|
|
83
|
+
|
|
5
84
|
## 10.8.0 — 2026-09-15
|
|
6
85
|
|
|
7
86
|
### 🎉 Features
|
|
@@ -334,7 +413,7 @@ All notable changes to this project will be documented in this file.
|
|
|
334
413
|
|
|
335
414
|
### ♻️ Refactoring
|
|
336
415
|
|
|
337
|
-
-
|
|
416
|
+
- Move defineConfig to a dedicated config subpath (#566)
|
|
338
417
|
|
|
339
418
|
`defineConfig` now comes from the `@williamthorsen/release-kit/config` subpath rather than from the package root. The subpath also carries the config types.
|
|
340
419
|
|
|
@@ -680,11 +759,11 @@ All notable changes to this project will be documented in this file.
|
|
|
680
759
|
|
|
681
760
|
### ♻️ Refactoring
|
|
682
761
|
|
|
683
|
-
-
|
|
762
|
+
- Rename `component` to `workspace` in config API and internals (#296)
|
|
684
763
|
|
|
685
764
|
Renames release-kit's per-workspace vocabulary from "component" to "workspace" throughout the public API, internal types, validation messages, CLI help, init templates, and documentation. Behavior is unchanged; only identifiers, error-message strings, scaffolded template text, and prose have been changed.
|
|
686
765
|
|
|
687
|
-
-
|
|
766
|
+
- Rename `node-monorepo-core` to `nmr-core` (#304)
|
|
688
767
|
|
|
689
768
|
Renames the shared-utilities package from `@williamthorsen/node-monorepo-core` to `@williamthorsen/nmr-core`, aligning it with the repository's `nmr-*` naming convention. The package's functionality and version are unchanged; only the published name differs.
|
|
690
769
|
|
package/README.md
CHANGED
|
@@ -7,20 +7,53 @@ Version-bumping and changelog-generation toolkit for release workflows.
|
|
|
7
7
|
Provides a self-contained CLI that auto-discovers workspaces from `pnpm-workspace.yaml`, parses conventional commits, determines version bumps, updates `package.json` files, and generates changelogs from `git-cliff --context` output rendered in-process (with optional [editorial overrides](docs/editorial-overrides.md)).
|
|
8
8
|
|
|
9
9
|
<!-- section:release-notes -->
|
|
10
|
-
## Release notes —
|
|
10
|
+
## Release notes — v11.0.0 (2026-09-22)
|
|
11
11
|
|
|
12
12
|
### 🎉 Features
|
|
13
13
|
|
|
14
|
-
-
|
|
14
|
+
- 🚨 **Breaking:** Return the provenance check's remediation as the outcome's fix (#855)
|
|
15
15
|
|
|
16
|
-
-
|
|
17
|
-
-
|
|
16
|
+
- Moves the remediation of the `npm-auto-publish` kit's `Provenance setting matches repo visibility` check from the failing outcome's `detail` into its `fix`, so that readyup marks it as a remedy, lists it in the `Fixes` recap, and reports it under `rdy run --json --detail summary` instead of printing it as a plain reason line.
|
|
17
|
+
- Declares `minReadyupVersion: '0.37.0'` on the kit, the readyup release that introduced `CheckOutcome.fix`, which retires the kit's `version-skew` advisory and makes an older runner fail to load the kit.
|
|
18
|
+
|
|
19
|
+
Migration: Upgrade readyup to 0.37.0 or later before consuming this release of the `npm-auto-publish` kit.
|
|
20
|
+
|
|
21
|
+
- Accept a --config argument on every config-reading subcommand (#857)
|
|
22
|
+
|
|
23
|
+
- Adds `--config <path>` to `prepare`, `publish`, `create-github-release`, `show-tag-prefixes`, `overrides validate`, `sync-labels init`, and `sync-labels generate`, each of which then reads the named file in place of `.config/release-kit.config.ts`.
|
|
24
|
+
- Requires a named `--config` file to exist, failing if it does not; an absent default path continues to mean that the repo declares no config.
|
|
25
|
+
- Confines scaffolding to the default path: `release-kit init` and `sync-labels init` still write `.config/release-kit.config.ts`, and `sync-labels init --config` reads the named file and fails when it is absent.
|
|
26
|
+
|
|
27
|
+
- 🚨 **Breaking:** Adopt the shared workspace resolver in release-kit, honoring exclusions (#865)
|
|
28
|
+
|
|
29
|
+
- 🚨 **Breaking:** Narrows `no-pattern` in `@williamthorsen/nmr-core`'s `EmptyWorkspaceCause`, moving an absent or empty `packages` list onto `no-packages-list` and a value that is not a list of strings onto `unreadable-packages`.
|
|
30
|
+
- Stops `release-kit` from tagging, publishing, and label-syncing a package that a `!` entry in `pnpm-workspace.yaml` excludes, which its previous `glob`-based resolution could not remove from the match.
|
|
31
|
+
- Replaces the release of the root package alone with a failure naming the condition that emptied the workspace, when `pnpm-workspace.yaml` does not hold valid YAML or declares a workspace that does not resolve to a package.
|
|
32
|
+
- Replaces the `no-pattern` remedy that `nmr` printed for a `pnpm-workspace.yaml` declaring no `packages` list, and for one declaring a `packages` value that is not a list of strings.
|
|
33
|
+
- Raises `engines.node` to `>=24.16.0` in `@williamthorsen/nmr-core` and `@williamthorsen/release-kit`, because Node 24.0 through 24.15 ignores the `followSymlinks` option that the workspace matcher passes to `globSync` and drops a symlinked package directory from the resolution without reporting it.
|
|
34
|
+
|
|
35
|
+
Migration: Add a `no-packages-list` arm and an `unreadable-packages` arm to any `switch` that covers `EmptyWorkspaceCause` exhaustively. `no-pattern` now names only a list that the resolver read in full and whose entries all failed to become a positive pattern, so move the handling of an absent `packages` key, an empty list, and a value that is not a list of strings out of the `no-pattern` arm into the two new ones. Route `no-packages-list` to single-package behavior rather than to a failure path: pnpm resolves such a manifest to the root package alone.
|
|
18
36
|
|
|
19
37
|
### 🐛 Bug fixes
|
|
20
38
|
|
|
21
|
-
-
|
|
39
|
+
- Truncate release-kit commit subjects by display column (#840)
|
|
40
|
+
|
|
41
|
+
- Fixes the issue that the `release-kit` prepare report cut a commit subject at 69 UTF-16 code units instead of at display columns, so a subject of CJK characters printed about twice the intended 72-column width and a cut inside an emoji left a broken character that a terminal drew as a replacement glyph.
|
|
42
|
+
- Replaces the `...` marker on a truncated subject with `…`, the default of the width-aware truncation that now does the cutting.
|
|
43
|
+
- Exports `truncateToWidth` and `measureWidth` from `@williamthorsen/nmr-core`, which measure and cut text by display width without splitting a grapheme cluster.
|
|
22
44
|
|
|
23
|
-
|
|
45
|
+
- Abort show-tag-prefixes on an unusable config (#861)
|
|
46
|
+
|
|
47
|
+
- Fixes the issue that `release-kit show-tag-prefixes` silently ignored a config file that failed schema validation, which left the preview reading no `legacyIdentities` and no `retiredPackages` and reporting already-declared and retired tag prefixes as undeclared candidates; the command now prints those validation errors and exits 1 with no preview.
|
|
48
|
+
|
|
49
|
+
- Abort every config-reading command on an unusable default config (#869)
|
|
50
|
+
|
|
51
|
+
- Fixes `publish` proceeding on derived defaults when the default config file exists and fails to load, which silently dropped a configured `releaseNotes.shouldInjectIntoReadme`, `changelogJson.outputPath`, or `workTypes`; it now reports the failure and exits 1, as every other config-reading subcommand does.
|
|
52
|
+
- Fixes `publish` and `create-github-release` ignoring a broken or invalid default config when every requested tag names a private package, a case in which both commands return before any loader runs.
|
|
53
|
+
|
|
54
|
+
- Strip trailing Change trailers from changelog item bodies (#870)
|
|
55
|
+
|
|
56
|
+
- Fixes a changelog item body that kept a commit's trailing `Change:` trailers, which then appeared verbatim in the rendered release notes, including the notes injected into a README.
|
|
24
57
|
<!-- /section:release-notes -->
|
|
25
58
|
|
|
26
59
|
## Installation
|
|
@@ -54,10 +87,10 @@ Example output from `prepare --dry-run` in a monorepo whose `arrays` workspace h
|
|
|
54
87
|
[dry-run] Would bump packages/arrays/package.json
|
|
55
88
|
Generating changelogs...
|
|
56
89
|
[dry-run] Would run: npx --prefer-offline --yes git-cliff@<version> ... --output packages/arrays/CHANGELOG.md
|
|
57
|
-
|
|
90
|
+
🔖 arrays-v1.3.0
|
|
58
91
|
|
|
59
92
|
✅ Release preparation complete.
|
|
60
|
-
|
|
93
|
+
🔖 arrays-v1.3.0
|
|
61
94
|
[dry-run] Would write tmp/.release-tags: arrays-v1.3.0
|
|
62
95
|
[dry-run] Would write tmp/.release-summary
|
|
63
96
|
```
|
|
@@ -73,8 +106,8 @@ The CLI applies defaults to every discovered workspace and uses the bundled `cli
|
|
|
73
106
|
|
|
74
107
|
## How it works
|
|
75
108
|
|
|
76
|
-
1. **Workspace discovery**: reads `pnpm-workspace.yaml` and resolves its `packages`
|
|
77
|
-
2. **Config loading**: loads `.config/release-kit.config.ts` (if present) and merges it with discovered defaults.
|
|
109
|
+
1. **Workspace discovery**: reads `pnpm-workspace.yaml` and resolves its `packages` patterns to find workspace directories, applying pnpm's semantics — a `!`-prefixed entry excludes what it matches, wherever it appears in the list. Each directory containing a `package.json` becomes a workspace. The repo is treated as a single-package project when it holds no workspace file, and when the workspace file declares no `packages` list — a file kept for `catalog:` or `overrides:` alone, which pnpm likewise resolves to the root package. A workspace file that declares patterns resolving to no package is an error naming the condition that emptied it.
|
|
110
|
+
2. **Config loading**: loads `.config/release-kit.config.ts` (if present), or the file named by `--config`, and merges it with discovered defaults.
|
|
78
111
|
3. **Commit analysis**: for each workspace, finds commits since the last version tag, parses them for type and scope, and determines the appropriate version bump.
|
|
79
112
|
4. **Version bump + changelog**: bumps `package.json` versions, builds structured `ChangelogEntry[]` from `git-cliff --context`, applies any [editorial overrides](docs/editorial-overrides.md) from per-scope `.meta/changelog-overrides.json` files, and renders both `CHANGELOG.md` and `.meta/changelog.json` from that single source. `git-cliff` is invoked only for its `--context` JSON; markdown rendering happens in-process so `.meta/changelog.json` and `CHANGELOG.md` always agree.
|
|
80
113
|
5. **Release tags file**: writes computed tags to `tmp/.release-tags` for the release workflow to read when tagging and pushing.
|
|
@@ -102,6 +135,8 @@ The `scope|type:` format scopes a commit to a specific workspace in a monorepo.
|
|
|
102
135
|
|
|
103
136
|
Configuration is optional. The CLI works out of the box by auto-discovering workspaces and applying defaults. Create `.config/release-kit.config.ts` only when you need to customize behavior.
|
|
104
137
|
|
|
138
|
+
Every subcommand that reads a config accepts `--config <path>` to read a file elsewhere. An absent default path means "no config"; an absent `--config` path fails the command. See [Config file location](docs/configuration.md#config-file-location).
|
|
139
|
+
|
|
105
140
|
```typescript
|
|
106
141
|
import { defineConfig } from '@williamthorsen/release-kit/config';
|
|
107
142
|
|
|
@@ -173,7 +208,7 @@ No cliff config copy is needed — the bundled template is used automatically. T
|
|
|
173
208
|
- [Publishing](docs/publishing.md): `publish`, the publishability filter, and `create-github-release`
|
|
174
209
|
- [Changelogs](docs/changelogs.md): the `changelog.json` item schema, the git-cliff config, and release-notes injection
|
|
175
210
|
- [Editorial overrides](docs/editorial-overrides.md): correcting generated changelog entries, and `overrides validate`
|
|
176
|
-
- [Work types and tiers](docs/work-types.md): tiers, the `!` policy, markers, custom work types, and
|
|
211
|
+
- [Work types and tiers](docs/work-types.md): tiers, the `!` policy, markers, custom work types, and maintenance of the bundled taxonomy
|
|
177
212
|
- [Labels](docs/labels.md): `sync-labels`, label configuration, the workflow's triggers, and the `label-map.json` schema
|
|
178
213
|
- [Readiness checks](docs/readiness-checks.md): both readyup kits, and how to run each
|
|
179
214
|
- [Programmatic API](docs/api.md): `deriveWorkspaceConfig()`, the script-based approach, and `resolveReleaseTags`
|