@releasekit/notes 0.43.0 → 0.43.1
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/README.md +2 -40
- package/dist/{aggregator-FLRONORL.js → aggregator-SCGIHWXW.js} +2 -2
- package/dist/{chunk-YNGSEWF6.js → chunk-6HUNK367.js} +1 -1
- package/dist/{chunk-U5JUUEEQ.js → chunk-T54LUVMQ.js} +116 -73
- package/dist/{chunk-TNTTAFQ4.js → chunk-YIHEHXCU.js} +72 -31
- package/dist/cli.js +2 -2
- package/dist/index.js +3 -3
- package/docs/llm-providers.md +4 -18
- package/docs/monorepo.md +1 -16
- package/docs/templates.md +1 -1
- package/package.json +10 -10
- package/templates/angular/version.hbs +7 -0
- package/templates/github-release/release.md.ejs +1 -1
- package/templates/keep-a-changelog/version.liquid +21 -19
- package/docs/configuration.md +0 -403
package/README.md
CHANGED
|
@@ -57,45 +57,7 @@ releasekit-notes --input version-data.json \
|
|
|
57
57
|
|
|
58
58
|
## CLI Reference
|
|
59
59
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
| Flag | Description | Default |
|
|
63
|
-
|------|-------------|---------|
|
|
64
|
-
| `-i, --input <file>` | Input file path | stdin |
|
|
65
|
-
| `--changelog-mode <mode>` | Changelog location: `root`, `packages`, `both` | `root` |
|
|
66
|
-
| `--changelog-file <name>` | Changelog file name override | `CHANGELOG.md` |
|
|
67
|
-
| `--no-changelog` | Disable changelog generation | — |
|
|
68
|
-
| `--release-notes-dir <dir>` | Write per-version release-notes files to this directory | — |
|
|
69
|
-
| `--no-release-notes` | Disable release notes generation | — |
|
|
70
|
-
| `-t, --template <path>` | Template file or directory | built-in |
|
|
71
|
-
| `-e, --engine <engine>` | Template engine: `handlebars`, `liquid`, `ejs` | `liquid` |
|
|
72
|
-
| `--monorepo <mode>` | Monorepo mode: `root`, `packages`, `both` | — |
|
|
73
|
-
| `--llm-provider <name>` | LLM provider | — |
|
|
74
|
-
| `--llm-model <model>` | LLM model | — |
|
|
75
|
-
| `--llm-base-url <url>` | Base URL for openai-compatible providers | — |
|
|
76
|
-
| `--llm-tasks <tasks>` | Comma-separated tasks: `enhance`, `summarize`, `categorize`, `release-notes` | — |
|
|
77
|
-
| `--no-llm` | Disable LLM processing | — |
|
|
78
|
-
| `--target <package>` | Filter to a specific package name | — |
|
|
79
|
-
| `--config <path>` | Config file path | `releasekit.config.json` |
|
|
80
|
-
| `--regenerate` | Regenerate entire file instead of prepending | `false` |
|
|
81
|
-
| `--dry-run` | Preview without writing | `false` |
|
|
82
|
-
| `-v, --verbose` | Verbose logging (repeat for more: `-vv`) | — |
|
|
83
|
-
| `-q, --quiet` | Suppress non-error output | — |
|
|
84
|
-
|
|
85
|
-
### `releasekit-notes auth <provider>`
|
|
86
|
-
|
|
87
|
-
Store an API key for an LLM provider.
|
|
88
|
-
|
|
89
|
-
```bash
|
|
90
|
-
releasekit-notes auth openai
|
|
91
|
-
releasekit-notes auth anthropic --key sk-ant-...
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
Keys are saved to `~/.config/releasekit/auth.json`.
|
|
95
|
-
|
|
96
|
-
### `releasekit-notes providers`
|
|
97
|
-
|
|
98
|
-
List available LLM providers.
|
|
60
|
+
The commands are in the [CLI reference](../../docs/cli.md#releasekit-notes): [`generate`](../../docs/cli.md#releasekit-notes-generate) (the default), [`auth`](../../docs/cli.md#releasekit-notes-auth-provider) and [`providers`](../../docs/cli.md#releasekit-notes-providers).
|
|
99
61
|
|
|
100
62
|
## Configuration
|
|
101
63
|
|
|
@@ -242,7 +204,7 @@ const result = await runPipeline(input, config, false);
|
|
|
242
204
|
## Documentation
|
|
243
205
|
|
|
244
206
|
**Getting Started**
|
|
245
|
-
- [Configuration reference](
|
|
207
|
+
- [Configuration reference](../../docs/configuration.md#notes) — all `notes.*` options
|
|
246
208
|
- [LLM providers](./docs/llm-providers.md) — provider setup, auth, tasks, prompt customisation
|
|
247
209
|
|
|
248
210
|
**Guides**
|
|
@@ -14,7 +14,7 @@ import {
|
|
|
14
14
|
unwrapEnvelope,
|
|
15
15
|
warn,
|
|
16
16
|
writeMarkdown
|
|
17
|
-
} from "./chunk-
|
|
17
|
+
} from "./chunk-YIHEHXCU.js";
|
|
18
18
|
|
|
19
19
|
// ../config/dist/index.js
|
|
20
20
|
import * as fs from "fs";
|
|
@@ -85,15 +85,15 @@ var VersionCargoConfigSchema = z.object({
|
|
|
85
85
|
"Version Cargo.toml manifests. Detected Rust packages are versioned by default; set false to opt out (e.g. a vendored crate, or Rust versioning handled elsewhere)."
|
|
86
86
|
),
|
|
87
87
|
paths: z.array(z.string()).optional().describe(
|
|
88
|
-
"Directories, relative to each package, to bump a Cargo.toml in instead of the package's own directory. Ignored in group mode."
|
|
88
|
+
"Directories, relative to each package, to bump a Cargo.toml in instead of the package's own directory. Not searched recursively. Ignored in group mode."
|
|
89
89
|
)
|
|
90
90
|
});
|
|
91
91
|
var VersionPubConfigSchema = z.object({
|
|
92
92
|
enabled: z.boolean().default(true).describe(
|
|
93
|
-
"Version pubspec.yaml manifests. Detected Dart/Flutter packages are versioned by default; set false to opt out."
|
|
93
|
+
"Version pubspec.yaml manifests. Detected Dart/Flutter packages are versioned by default; set false to opt out, which also stops a pubspec.yaml beside a package.json from publishing."
|
|
94
94
|
),
|
|
95
95
|
paths: z.array(z.string()).optional().describe(
|
|
96
|
-
"Directories, relative to each package, to bump a pubspec.yaml in instead of the package's own directory. Ignored in group mode."
|
|
96
|
+
"Directories, relative to each package, to bump a pubspec.yaml in instead of the package's own directory. Not searched recursively. Ignored in group mode."
|
|
97
97
|
)
|
|
98
98
|
});
|
|
99
99
|
var VersionGroupSchema = z.object({
|
|
@@ -129,7 +129,7 @@ var VersionConfigSchema = z.object({
|
|
|
129
129
|
groups: z.record(z.string(), VersionGroupSchema).optional().describe(
|
|
130
130
|
"Named version groups. Each group binds a set of package patterns to a fixed, linked, or independent sync mode. fixed: any releasable change in any member releases ALL members at the shared group version (bump(max(member baselines))). linked: only members with releasable changes release, but every releasing member shares the same computed version. independent: only members with releasable changes release, each on its own commit-driven version line (no shared version), but the set is atomic \u2014 targeting any member pulls in the whole group. Packages not matched by any group version independently. A package may belong to at most one group. Set version.sync to false when using groups."
|
|
131
131
|
),
|
|
132
|
-
packages: z.array(z.string()).default([]).describe("Packages to include in versioning"),
|
|
132
|
+
packages: z.array(z.string()).default([]).describe("Packages to include in versioning. Empty includes every discovered package."),
|
|
133
133
|
sharedPackages: z.array(z.string()).optional().describe(
|
|
134
134
|
'Foundational packages whose changes belong in every package\u2019s changelog. A commit touching only a shared package (exact name or glob) is classified as repo-level and surfaced under "Project-wide changes" rather than attributed to that one package. Default: none \u2014 no package is treated as shared unless declared.'
|
|
135
135
|
),
|
|
@@ -143,7 +143,10 @@ var VersionConfigSchema = z.object({
|
|
|
143
143
|
includePrivate: z.boolean().default(false).describe(
|
|
144
144
|
'Include npm packages marked "private": true (in package.json) in the release flow. Default false: private packages are skipped at discovery \u2014 they cannot be published to any registry, mirroring the Cargo `publish = false` and pub `publish_to: none` skips already applied during discovery. Set true to version a private package for internal tracking. Packages explicitly named in version.packages are always included regardless of this setting.'
|
|
145
145
|
),
|
|
146
|
-
commitMessage: z.string().optional().describe(
|
|
146
|
+
commitMessage: z.string().optional().describe(
|
|
147
|
+
// biome-ignore lint/suspicious/noTemplateCurlyInString: documenting placeholder syntax to the user
|
|
148
|
+
"Template for the release commit message. Supports ${version} and ${packageName}. Default: 'chore: release ${packageName} v${version}' for sync and single-package releases; otherwise 'chore: release' followed by each released package and version."
|
|
149
|
+
),
|
|
147
150
|
mismatchStrategy: z.enum(["error", "warn", "ignore", "prefer-package", "prefer-git"]).default("warn").describe("How to handle version mismatches"),
|
|
148
151
|
versionPrefix: z.string().default("").describe("Prefix for version tags"),
|
|
149
152
|
prereleaseIdentifier: z.string().optional().describe("Identifier for prerelease versions (e.g., 'alpha', 'beta')"),
|
|
@@ -174,15 +177,19 @@ var CargoPublishConfigSchema = z.object({
|
|
|
174
177
|
enabled: z.boolean().default(true).describe(
|
|
175
178
|
"Publish to crates.io. Detected Rust packages are published by default; set false to opt out (version and tag only)."
|
|
176
179
|
),
|
|
177
|
-
noVerify: z.boolean().default(false).describe(
|
|
178
|
-
|
|
179
|
-
|
|
180
|
+
noVerify: z.boolean().default(false).describe(
|
|
181
|
+
"Pass --no-verify to cargo publish, skipping the pre-publish build of the packaged crate. Use only as a temporary workaround for a build that fails in CI."
|
|
182
|
+
),
|
|
183
|
+
publishOrder: z.array(z.string()).default([]).describe(
|
|
184
|
+
"Crate names to publish first, in this order; the rest follow in discovery order. Empty sorts crates by their path dependencies."
|
|
185
|
+
),
|
|
186
|
+
clean: z.boolean().default(false).describe("Run cargo clean in each crate's directory before publishing.")
|
|
180
187
|
});
|
|
181
188
|
var PubPublishConfigSchema = z.object({
|
|
182
189
|
enabled: z.boolean().default(true).describe(
|
|
183
190
|
"Publish to pub.dev. Detected Dart/Flutter packages are published by default; set false to opt out (version and tag only)."
|
|
184
191
|
),
|
|
185
|
-
publishOrder: z.array(z.string()).default([]).describe("
|
|
192
|
+
publishOrder: z.array(z.string()).default([]).describe("Package names to publish first, in this order; the rest follow in discovery order.")
|
|
186
193
|
});
|
|
187
194
|
var PublishGitConfigSchema = z.object({
|
|
188
195
|
push: z.boolean().optional().describe("Push tags and commits to remote. When unset, inherits the top-level git.push (which defaults to push)."),
|
|
@@ -203,26 +210,28 @@ var GitHubReleaseConfigSchema = z.object({
|
|
|
203
210
|
/* biome-ignore lint/suspicious/noTemplateCurlyInString: default template value */
|
|
204
211
|
titleTemplate: z.string().default("${packageName}: ${version}").describe(
|
|
205
212
|
// biome-ignore lint/suspicious/noTemplateCurlyInString: documenting placeholder syntax to the user
|
|
206
|
-
"Template for the GitHub release title when a package name is resolved. Available variables: ${packageName} (original scoped name, e.g. '@scope/pkg'), ${version} (e.g. 'v1.0.0').
|
|
213
|
+
"Template for the GitHub release title when a package name is resolved. Available variables: ${packageName} (original scoped name, e.g. '@scope/pkg'), ${version} (the package's new version, with a 'v' when its tag has one, e.g. 'v1.0.0'). Tags without a package name, e.g. 'v1.0.0' or 'release-1.0.0', are used as the title unchanged."
|
|
207
214
|
),
|
|
208
|
-
skipPackages: z.array(z.string()).default([]).describe(
|
|
215
|
+
skipPackages: z.array(z.string()).default([]).describe(
|
|
216
|
+
"Package names to exclude from GitHub release creation. The name as tags spell it also matches, e.g. 'scope-pkg' for '@scope/pkg'."
|
|
217
|
+
)
|
|
209
218
|
});
|
|
210
219
|
var VerifyRegistryNpmConfigSchema = z.object({
|
|
211
220
|
enabled: z.boolean().default(true).describe("Verify NPM publish"),
|
|
212
221
|
maxAttempts: z.number().int().positive().default(5).describe("Maximum verification attempts"),
|
|
213
|
-
initialDelay: z.number().int().positive().default(15e3).describe("
|
|
222
|
+
initialDelay: z.number().int().positive().default(15e3).describe("Wait in ms after the first failed check; each later wait is multiplied by backoffMultiplier."),
|
|
214
223
|
backoffMultiplier: z.number().positive().default(2).describe("Exponential backoff multiplier")
|
|
215
224
|
});
|
|
216
225
|
var VerifyRegistryCargoConfigSchema = z.object({
|
|
217
226
|
enabled: z.boolean().default(true).describe("Verify Cargo publish"),
|
|
218
227
|
maxAttempts: z.number().int().positive().default(10).describe("Maximum verification attempts"),
|
|
219
|
-
initialDelay: z.number().int().positive().default(3e4).describe("
|
|
228
|
+
initialDelay: z.number().int().positive().default(3e4).describe("Wait in ms after the first failed check; each later wait is multiplied by backoffMultiplier."),
|
|
220
229
|
backoffMultiplier: z.number().positive().default(2).describe("Exponential backoff multiplier")
|
|
221
230
|
});
|
|
222
231
|
var VerifyRegistryPubConfigSchema = z.object({
|
|
223
232
|
enabled: z.boolean().default(true).describe("Verify Dart pub publish"),
|
|
224
233
|
maxAttempts: z.number().int().positive().default(10).describe("Maximum verification attempts"),
|
|
225
|
-
initialDelay: z.number().int().positive().default(3e4).describe("
|
|
234
|
+
initialDelay: z.number().int().positive().default(3e4).describe("Wait in ms after the first failed check; each later wait is multiplied by backoffMultiplier."),
|
|
226
235
|
backoffMultiplier: z.number().positive().default(2).describe("Exponential backoff multiplier")
|
|
227
236
|
});
|
|
228
237
|
var VerifyConfigSchema = z.object({
|
|
@@ -231,19 +240,21 @@ var VerifyConfigSchema = z.object({
|
|
|
231
240
|
maxAttempts: 5,
|
|
232
241
|
initialDelay: 15e3,
|
|
233
242
|
backoffMultiplier: 2
|
|
234
|
-
}),
|
|
243
|
+
}).describe("Poll npm after each publish until the new version is visible."),
|
|
235
244
|
cargo: VerifyRegistryCargoConfigSchema.default({
|
|
236
245
|
enabled: true,
|
|
237
246
|
maxAttempts: 10,
|
|
238
247
|
initialDelay: 3e4,
|
|
239
248
|
backoffMultiplier: 2
|
|
240
|
-
})
|
|
249
|
+
}).describe(
|
|
250
|
+
"Poll crates.io after each publish until the new version is visible. Its index updates more slowly than npm's, so the defaults wait longer."
|
|
251
|
+
),
|
|
241
252
|
pub: VerifyRegistryPubConfigSchema.default({
|
|
242
253
|
enabled: true,
|
|
243
254
|
maxAttempts: 10,
|
|
244
255
|
initialDelay: 3e4,
|
|
245
256
|
backoffMultiplier: 2
|
|
246
|
-
})
|
|
257
|
+
}).describe("Poll pub.dev after each publish until the new version is visible.")
|
|
247
258
|
});
|
|
248
259
|
var PublishConfigSchema = z.object({
|
|
249
260
|
git: PublishGitConfigSchema.optional().describe("Git publishing options"),
|
|
@@ -299,8 +310,8 @@ var PublishConfigSchema = z.object({
|
|
|
299
310
|
}).describe("Registry verification configuration")
|
|
300
311
|
});
|
|
301
312
|
var TemplateConfigSchema = z.object({
|
|
302
|
-
path: z.string().optional().describe("
|
|
303
|
-
engine: z.enum(["handlebars", "liquid", "ejs"]).optional().describe("Template engine")
|
|
313
|
+
path: z.string().optional().describe("Template file, or a directory of composable templates."),
|
|
314
|
+
engine: z.enum(["handlebars", "liquid", "ejs"]).optional().describe("Template engine. Detected from the template files when omitted; ignored without path.")
|
|
304
315
|
});
|
|
305
316
|
var LocationModeSchema = z.enum(["root", "packages", "both"]);
|
|
306
317
|
var ReleaseNotesFileConfigSchema = z.object({
|
|
@@ -308,7 +319,7 @@ var ReleaseNotesFileConfigSchema = z.object({
|
|
|
308
319
|
});
|
|
309
320
|
var ChangelogConfigSchema = z.object({
|
|
310
321
|
mode: LocationModeSchema.optional().describe(
|
|
311
|
-
"Where to write changelog files
|
|
322
|
+
"Where to write changelog files: 'root' (the default) at the repo root, 'packages' in each package (monorepos only), or 'both'."
|
|
312
323
|
),
|
|
313
324
|
file: z.string().optional().describe("Changelog file name override (default: CHANGELOG.md)"),
|
|
314
325
|
templates: TemplateConfigSchema.optional().describe("Template configuration for changelog"),
|
|
@@ -316,25 +327,25 @@ var ChangelogConfigSchema = z.object({
|
|
|
316
327
|
"How `#NNN` issue/PR refs in the changelog are rendered. Applies to the whole entry \u2014 both the appended label and any bare `#N` carried over from the commit subject into the description (a description ref that also appears in the appended label is de-duplicated away). 'link' (default): the PR and the issues it closed are labelled as `(PR #503 \xB7 closes #500)`, where the PR links to its canonical /pull/ URL with `PR #503` as the visible text \u2014 this keeps the GitHub hovercard but stops the bare-token rich inline card that duplicated the entry; closed issues link to /issues/. An entry with no identifiable PR (a non-squash commit, or a non-GitHub repo) falls back to a plain ref list. 'escape': plain text \\#NNN (no link, no hovercard, no PR/closes labelling). 'strip': refs are removed entirely. Scoped-package / @user mentions in entry text are always neutralised regardless of this setting."
|
|
317
328
|
),
|
|
318
329
|
demoteScopes: z.array(z.string()).default([...DEFAULT_DEMOTE_SCOPES]).describe(
|
|
319
|
-
'Conventional-commit scopes whose changelog entries
|
|
330
|
+
'Conventional-commit scopes whose changelog entries move to a trailing "Dependencies & version bumps" subsection instead of mixing with Added / Fixed / Changed. A breaking change still comes first, under Breaking. Applies to the release preview comment and the standing-PR changelogs (each releasable row and the "Show all changes" footer). Entries are moved, not dropped, so the de-duplicated change count is unchanged. Default: ["deps", "deps-dev"], the scopes Dependabot uses. Set to [] to render every scope inline.'
|
|
320
331
|
)
|
|
321
332
|
}).describe("Changelog file configuration");
|
|
322
333
|
var LLMOptionsSchema = z.object({
|
|
323
|
-
timeout: z.number().int().optional().describe("Idle timeout in ms: a streamed response fails only when nothing arrives for this long"),
|
|
324
|
-
maxTokens: z.number().int().optional().describe("Max tokens to generate"),
|
|
325
|
-
temperature: z.number().optional().describe("Sampling temperature")
|
|
334
|
+
timeout: z.number().int().optional().describe("Idle timeout in ms: a streamed response fails only when nothing arrives for this long. Default: 60000."),
|
|
335
|
+
maxTokens: z.number().int().optional().describe("Max tokens to generate. Default: 16384."),
|
|
336
|
+
temperature: z.number().optional().describe("Sampling temperature. Default: 0.7; the anthropic provider ignores it.")
|
|
326
337
|
});
|
|
327
338
|
var LLMRetryConfigSchema = z.object({
|
|
328
|
-
maxAttempts: z.number().int().positive().optional().describe("Maximum number of attempts"),
|
|
329
|
-
initialDelay: z.number().int().nonnegative().optional().describe("
|
|
330
|
-
maxDelay: z.number().int().positive().optional().describe("Maximum delay in ms"),
|
|
331
|
-
backoffFactor: z.number().positive().optional().describe("Delay multiplier per attempt")
|
|
339
|
+
maxAttempts: z.number().int().positive().optional().describe("Maximum number of attempts, including the first. Default: 3."),
|
|
340
|
+
initialDelay: z.number().int().nonnegative().optional().describe("Delay in ms before the first retry. Default: 1000."),
|
|
341
|
+
maxDelay: z.number().int().positive().optional().describe("Maximum delay in ms between attempts. Default: 30000."),
|
|
342
|
+
backoffFactor: z.number().positive().optional().describe("Delay multiplier per attempt. Default: 2.")
|
|
332
343
|
});
|
|
333
344
|
var LLMTasksConfigSchema = z.object({
|
|
334
|
-
summarize: z.boolean().optional().describe("
|
|
335
|
-
enhance: z.boolean().optional().describe("
|
|
336
|
-
categorize: z.boolean().optional().describe("
|
|
337
|
-
releaseNotes: z.boolean().optional().describe("
|
|
345
|
+
summarize: z.boolean().optional().describe("Write a 2\u20133 sentence summary of the release."),
|
|
346
|
+
enhance: z.boolean().optional().describe("Rewrite each entry's description to be clearer for users."),
|
|
347
|
+
categorize: z.boolean().optional().describe("Group entries into the configured categories."),
|
|
348
|
+
releaseNotes: z.boolean().optional().describe("Write prose release notes for the GitHub Release body and any release-notes files.")
|
|
338
349
|
});
|
|
339
350
|
var LLMCategorySchema = z.object({
|
|
340
351
|
name: z.string().describe("Category label shown in release notes (e.g. 'Features')"),
|
|
@@ -356,15 +367,15 @@ var ScopeConfigSchema = z.object({
|
|
|
356
367
|
rules: ScopeRulesSchema.optional().describe("Scope validation and transformation rules")
|
|
357
368
|
});
|
|
358
369
|
var LLMPromptOverridesSchema = z.object({
|
|
359
|
-
enhance: z.string().optional().describe("
|
|
360
|
-
categorize: z.string().optional().describe("
|
|
361
|
-
enhanceAndCategorize: z.string().optional().describe("
|
|
362
|
-
summarize: z.string().optional().describe("
|
|
363
|
-
releaseNotes: z.string().optional().describe("
|
|
370
|
+
enhance: z.string().optional().describe("For the enhance task when categorize is off."),
|
|
371
|
+
categorize: z.string().optional().describe("For the categorize task when enhance is off."),
|
|
372
|
+
enhanceAndCategorize: z.string().optional().describe("For the combined task that replaces enhance and categorize when both are on."),
|
|
373
|
+
summarize: z.string().optional().describe("For the summarize task."),
|
|
374
|
+
releaseNotes: z.string().optional().describe("For the releaseNotes task.")
|
|
364
375
|
});
|
|
365
376
|
var LLMPromptsConfigSchema = z.object({
|
|
366
377
|
instructions: LLMPromptOverridesSchema.optional().describe(
|
|
367
|
-
"
|
|
378
|
+
"Extra instructions appended to a task's built-in system prompt. The task's output format is unchanged."
|
|
368
379
|
)
|
|
369
380
|
});
|
|
370
381
|
var LLMConfigBaseSchema = z.object({
|
|
@@ -373,29 +384,39 @@ var LLMConfigBaseSchema = z.object({
|
|
|
373
384
|
"Model identifier for the selected provider. Required \u2014 releasekit ships no default, so enabling LLM enhancement needs an explicit, current model (a missing model fails config validation)."
|
|
374
385
|
),
|
|
375
386
|
baseURL: z.string().optional().describe("Custom API base URL. Required for the openai-compatible provider."),
|
|
376
|
-
apiKey: z.string().optional().describe(
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
387
|
+
apiKey: z.string().optional().describe(
|
|
388
|
+
"API key. When unset, releasekit uses the key saved by releasekit-notes auth, then the provider's environment variable (e.g. OPENAI_API_KEY); prefer either to an inline key."
|
|
389
|
+
),
|
|
390
|
+
options: LLMOptionsSchema.optional().describe("Options for each request to the provider."),
|
|
391
|
+
concurrency: z.number().int().positive().optional().describe(
|
|
392
|
+
"Maximum packages processed at once and, separately, entries a package's standalone enhance task rewrites at once. Default: 5."
|
|
393
|
+
),
|
|
394
|
+
retry: LLMRetryConfigSchema.optional().describe("Retries for LLM requests that fail with a retryable error."),
|
|
395
|
+
tasks: LLMTasksConfigSchema.optional().describe("LLM tasks to run. Each is off unless set to true."),
|
|
381
396
|
categories: z.array(LLMCategorySchema).default(() => [
|
|
382
397
|
{ name: "Breaking", description: "Breaking changes that require user action to upgrade" },
|
|
383
398
|
{ name: "New", description: "New features and capabilities" },
|
|
384
399
|
{ name: "Changed", description: "Changes to existing functionality" },
|
|
385
400
|
{ name: "Fixed", description: "Bug fixes" },
|
|
386
401
|
{ name: "Developer", description: "Internal changes: CI, tooling, dependencies, refactoring" }
|
|
387
|
-
])
|
|
402
|
+
]).describe(
|
|
403
|
+
"Categories the categorize task sorts entries into. Default: Breaking, New, Changed, Fixed and Developer, each with a built-in description."
|
|
404
|
+
),
|
|
388
405
|
style: z.string().default(
|
|
389
406
|
'Write in past tense ("Added feature", not "Add feature"). Be concise and user-focused. Lead with the impact, not the implementation detail.'
|
|
390
|
-
).describe(
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
407
|
+
).describe(
|
|
408
|
+
"Writing-style instruction for the enhance task, alone or combined with categorize. Default: past tense, concise and user-focused, leading with the impact."
|
|
409
|
+
),
|
|
410
|
+
scopes: ScopeConfigSchema.optional().describe("Validation of the scopes the LLM assigns to entries."),
|
|
411
|
+
prompts: LLMPromptsConfigSchema.optional().describe("Per-task prompt additions."),
|
|
412
|
+
examples: z.number().int().min(0).max(5).default(3).describe(
|
|
413
|
+
"Number of the project's past GitHub Releases (0\u20135) used as style examples in the combined enhance and categorize prompt and the releaseNotes prompt. Needs GITHUB_TOKEN or GH_TOKEN."
|
|
414
|
+
),
|
|
394
415
|
context: z.object({
|
|
395
|
-
pullRequests: z.boolean().default(true).describe("
|
|
416
|
+
pullRequests: z.boolean().default(true).describe("Fetch the title and body of each entry's linked PR as LLM context. Needs GITHUB_TOKEN or GH_TOKEN.")
|
|
396
417
|
}).default({ pullRequests: true }).describe("Additional context sources for the LLM."),
|
|
397
418
|
categoryOrder: z.array(z.string()).optional().describe(
|
|
398
|
-
"
|
|
419
|
+
"Order of the rendered categories. Listed ones come first; the rest keep their order in categories, except Breaking, which stays first unless listed."
|
|
399
420
|
),
|
|
400
421
|
cache: z.boolean().default(false).describe(
|
|
401
422
|
"Cache LLM responses on disk (under the OS temp dir), keyed by a hash of the provider, model, prompt, and request options. A re-run or backfill with the same inputs reuses the cached generation instead of re-calling the provider. Off by default."
|
|
@@ -424,16 +445,20 @@ var ReleaseNotesConfigSchema = z.object({
|
|
|
424
445
|
label: z.string().describe("Link text"),
|
|
425
446
|
url: z.string().url().describe("Link URL")
|
|
426
447
|
})
|
|
427
|
-
).optional().describe("Static
|
|
428
|
-
fromPRBodyMarker: z.string().optional().describe(
|
|
429
|
-
|
|
430
|
-
|
|
448
|
+
).optional().describe("Static links, each { label, url }, listed first."),
|
|
449
|
+
fromPRBodyMarker: z.string().optional().describe(
|
|
450
|
+
"Also collect links from linked PR bodies: each line starting with this marker adds its markdown link or bare URL, skipping URLs already listed. Needs llm.context.pullRequests."
|
|
451
|
+
),
|
|
452
|
+
title: z.string().optional().describe("Heading for the links section. Default: Links.")
|
|
453
|
+
}).optional().describe(
|
|
454
|
+
"Links section the built-in renderer appends to each version. Rendered only when the categorize task produced categories."
|
|
455
|
+
),
|
|
431
456
|
firstRelease: z.union([
|
|
432
457
|
z.literal(false).describe("Set to false to disable the first-release placeholder intro."),
|
|
433
458
|
z.object({
|
|
434
459
|
text: z.string().optional().describe(
|
|
435
460
|
// biome-ignore lint/suspicious/noTemplateCurlyInString: documenting placeholder syntax to the user
|
|
436
|
-
"Placeholder intro line for a package's first release. Supports ${packageName} and ${version}.
|
|
461
|
+
"Placeholder intro line for a package's first release. Supports ${packageName} and ${version}. Default: '_First release of ${packageName}._'."
|
|
437
462
|
)
|
|
438
463
|
})
|
|
439
464
|
]).optional().describe(
|
|
@@ -445,10 +470,12 @@ var NotesInputConfigSchema = z.object({
|
|
|
445
470
|
file: z.string().optional()
|
|
446
471
|
});
|
|
447
472
|
var NotesConfigSchema = z.object({
|
|
448
|
-
changelog: z.union([z.literal(false).describe("Set to false to disable changelog generation"), ChangelogConfigSchema]).optional(),
|
|
449
|
-
releaseNotes: z.union([z.literal(false).describe("Set to false to disable release notes"), ReleaseNotesConfigSchema]).optional()
|
|
473
|
+
changelog: z.union([z.literal(false).describe("Set to false to disable changelog generation"), ChangelogConfigSchema]).optional().describe("Changelog generation, on by default. Set to false to disable."),
|
|
474
|
+
releaseNotes: z.union([z.literal(false).describe("Set to false to disable release notes"), ReleaseNotesConfigSchema]).optional().describe(
|
|
475
|
+
"Release notes for the GitHub Release body and optional per-version files. Off unless set. {} turns them on using each version's changelog section; set llm or templates to change the content."
|
|
476
|
+
),
|
|
450
477
|
updateStrategy: z.enum(["prepend", "regenerate"]).optional().describe(
|
|
451
|
-
"How to update existing changelog files. 'prepend' adds new entries
|
|
478
|
+
"How to update existing changelog files. 'prepend' (the default) adds the new entries at the top; 'regenerate' overwrites the file with this run's output."
|
|
452
479
|
)
|
|
453
480
|
});
|
|
454
481
|
var CILabelsConfigSchema = z.object({
|
|
@@ -458,8 +485,10 @@ var CILabelsConfigSchema = z.object({
|
|
|
458
485
|
graduatePackagePrefix: z.string().default("graduate:").describe(
|
|
459
486
|
"Prefix for per-package graduate labels on the standing PR. A `graduate:<package>` label graduates just that prerelease package (and, atomically, any fixed/linked group it belongs to) to its stable base version on the next update, while other prerelease packages stay on their line. The whole-batch `graduate` label still graduates everything. Standing-pr mode only."
|
|
460
487
|
),
|
|
461
|
-
prerelease: z.string().default("channel:prerelease").describe("Label
|
|
462
|
-
skip: z.string().default("release:skip").describe(
|
|
488
|
+
prerelease: z.string().default("channel:prerelease").describe("Label that makes the release a prerelease. In label-trigger mode it needs a bump label too."),
|
|
489
|
+
skip: z.string().default("release:skip").describe(
|
|
490
|
+
"Label that stops a merged PR from releasing. Commit-trigger mode only; in label mode, leave off the bump label instead."
|
|
491
|
+
),
|
|
463
492
|
immediate: z.string().default("release:immediate").describe("Label to bypass the standing PR for one merge \u2014 triggers a direct release. Standing-pr mode only."),
|
|
464
493
|
retry: z.string().default("release:retry").describe("Label to retry a failed publish by re-applying it to a merged standing PR. Standing-pr mode only."),
|
|
465
494
|
previewNotes: z.string().default("release:preview-notes").describe(
|
|
@@ -473,18 +502,24 @@ var CILabelsConfigSchema = z.object({
|
|
|
473
502
|
)
|
|
474
503
|
});
|
|
475
504
|
var StandingPrConfigSchema = z.object({
|
|
476
|
-
branch: z.string().default("release/next").describe(
|
|
505
|
+
branch: z.string().default("release/next").describe(
|
|
506
|
+
"Branch name for the standing release PR. Each update resets it to the base branch and force-pushes it, so don't commit to it."
|
|
507
|
+
),
|
|
477
508
|
title: z.string().optional().describe(
|
|
478
509
|
// biome-ignore lint/suspicious/noTemplateCurlyInString: documenting placeholder syntax to the user
|
|
479
|
-
"PR title template. Variables: ${count} (publishable package count), ${version} (
|
|
510
|
+
"PR title template. Variables: ${count} (publishable package count), ${version} (the first publishable package's new version), ${tag} (version with tag prefix). Also the release commit's subject, so it must match a release.ci.skipPatterns entry and carry no CI-skip marker. A title with a CI-skip marker is replaced by 'chore: release preparation'. So is one the skip patterns miss, if they match 'chore: release preparation'. The run warns either way. Default depends on the versioning strategy: 'chore: release ${tag}' in sync mode, 'chore: release ${count} package(s)' otherwise."
|
|
511
|
+
),
|
|
512
|
+
labels: z.array(z.string()).default(["release"]).describe(
|
|
513
|
+
"Labels to apply to the standing release PR. Don't include bump, channel, scope or release labels: the standing PR reads its own labels as release overrides."
|
|
480
514
|
),
|
|
481
|
-
labels: z.array(z.string()).default(["release"]).describe("Labels to apply to the standing release PR."),
|
|
482
515
|
deleteBranchOnMerge: z.boolean().default(true).describe(
|
|
483
516
|
"Whether to auto-delete the release branch after the PR is merged. Publish keeps it if an update has moved it since the merge, or if the merged PR's head commit can't be read."
|
|
484
517
|
),
|
|
485
|
-
mergeMethod: z.enum(["merge", "squash", "rebase"]).default("merge").describe(
|
|
518
|
+
mergeMethod: z.enum(["merge", "squash", "rebase"]).default("merge").describe(
|
|
519
|
+
"Merge method for releasekit standing-pr merge. Use 'squash' or 'rebase' so the release commit's subject reaches the base branch, where release.ci.skipPatterns can match it."
|
|
520
|
+
),
|
|
486
521
|
minAge: z.string().optional().describe(
|
|
487
|
-
"Minimum age of the standing PR before it can be merged. Duration string, e.g. '6h', '30m', '1d'. Gate enforced via the releasekit/standing-pr commit status check; configure it as a required status check in branch protection to block merges."
|
|
522
|
+
"Minimum age of the standing PR, counted from when it was first opened, before it can be merged. Duration string, e.g. '6h', '30m', '1d'. Gate enforced via the releasekit/standing-pr commit status check; configure it as a required status check in branch protection to block merges."
|
|
488
523
|
),
|
|
489
524
|
minPackages: z.number().int().positive().optional().describe(
|
|
490
525
|
"Minimum number of packages with releasable changes required to create or maintain the standing PR. Below this threshold the PR is closed and no new PR is opened."
|
|
@@ -505,7 +540,7 @@ var StandingPrConfigSchema = z.object({
|
|
|
505
540
|
"Refuse to publish the standing PR when the actor who merged it is not authorized (defense-in-depth behind a branch-protection ruleset, which is the primary merge gate). Set false to rely on branch protection alone."
|
|
506
541
|
)
|
|
507
542
|
}).optional().describe(
|
|
508
|
-
"Restrict who can steer the standing PR \u2014 its selection checkboxes, per-row channel toggles, release labels, and merge. Omit to allow anyone with the GitHub permission GitHub itself requires for each action
|
|
543
|
+
"Restrict who can steer the standing PR \u2014 its selection checkboxes, per-row channel toggles, release labels, and merge. Omit to allow anyone with the GitHub permission GitHub itself requires for each action."
|
|
509
544
|
),
|
|
510
545
|
primaryPackages: z.array(z.string()).default([]).describe(
|
|
511
546
|
"Packages that drive releases \u2014 rendered as parent rows in the standing-PR selection list, with their coupled group-mates and changed prerequisites nested beneath, so one parent toggle holds back the whole release unit. Glob patterns or exact names. Empty (default) \u2192 flat per-package list (current behavior)."
|
|
@@ -514,7 +549,7 @@ var StandingPrConfigSchema = z.object({
|
|
|
514
549
|
"How the selection list renders when primaryPackages is set. streamlined: one checkbox per primary, coupled members shown read-only in a collapsed pane, and a held-back primary cascades to its unit. granular: every package keeps its own checkbox, nested under its primary, with no cascade. No effect when primaryPackages is empty."
|
|
515
550
|
),
|
|
516
551
|
combinedChangelogFooter: z.boolean().default(true).describe(
|
|
517
|
-
"Append the de-duplicated combined-changelog footer to the standing PR: every change listed once, flat across packages and grouped by change type (Added/Fixed/Changed). It complements the per-row changelogs co-located with each releasable row. Set false to suppress this redundant per-package summary \u2014 the per-row changelogs remain, project-wide (shared) changes are still shown in their own block, and sync releases (which have no per-row changelogs) always show the combined changelog regardless of this setting."
|
|
552
|
+
"Append the de-duplicated combined-changelog footer to the standing PR: every change listed once, flat across packages and grouped by change type (Added/Fixed/Changed), breaking changes first. It complements the per-row changelogs co-located with each releasable row. Set false to suppress this redundant per-package summary \u2014 the per-row changelogs remain, project-wide (shared) changes are still shown in their own block, and sync releases (which have no per-row changelogs) always show the combined changelog regardless of this setting."
|
|
518
553
|
),
|
|
519
554
|
channelToggle: z.boolean().default(false).describe(
|
|
520
555
|
"Add a per-row channel toggle to the standing-PR selection list: a nested checkbox under each releasable row to ship a stable package as a prerelease (\u2192 X.Y.Z-next.0 on the `next` dist-tag) or graduate a prerelease package to its stable base \u2014 shifting just that package (and its group) without narrowing the release. Off by default so repos that do not need it keep the tight one-line-per-package list. A held-back (unticked) row hides its channel toggle. No effect on sync releases (which ship atomically as one unit)."
|
|
@@ -564,7 +599,9 @@ var CIConfigSchema = z.object({
|
|
|
564
599
|
)
|
|
565
600
|
});
|
|
566
601
|
var ReleaseCIConfigSchema = z.object({
|
|
567
|
-
skipPatterns: z.array(z.string().min(1)).optional().describe(
|
|
602
|
+
skipPatterns: z.array(z.string().min(1)).optional().describe(
|
|
603
|
+
"Strings that skip a release, gate run or standing-PR update when found anywhere in the HEAD commit's subject. When unset, only standing-PR updates skip, and only on 'chore: release '."
|
|
604
|
+
),
|
|
568
605
|
minChanges: z.number().int().positive().optional().describe("Minimum number of packages with releasable changes required to trigger a release"),
|
|
569
606
|
githubRelease: z.literal(false).optional().describe("Set to false to disable GitHub release creation in CI"),
|
|
570
607
|
notes: z.literal(false).optional().describe("Set to false to disable changelog generation in CI")
|
|
@@ -1039,7 +1076,7 @@ function isBotComment(comment) {
|
|
|
1039
1076
|
if (!user) {
|
|
1040
1077
|
return true;
|
|
1041
1078
|
}
|
|
1042
|
-
return user.type === "Bot" || user.login
|
|
1079
|
+
return user.type === "Bot" || user.login?.endsWith("[bot]") === true;
|
|
1043
1080
|
}
|
|
1044
1081
|
var REPO_PERMISSIONS = ["admin", "maintain", "write", "triage", "read", "none"];
|
|
1045
1082
|
var MAX_RELEASE_PAGES = 3;
|
|
@@ -1129,7 +1166,13 @@ var GitHubForge = class {
|
|
|
1129
1166
|
}
|
|
1130
1167
|
async getPullRequest(prNumber) {
|
|
1131
1168
|
const { data } = await this.octokit.rest.pulls.get({ ...this.base, pull_number: prNumber });
|
|
1132
|
-
return {
|
|
1169
|
+
return {
|
|
1170
|
+
body: data.body ?? "",
|
|
1171
|
+
labels: labelNames(data.labels),
|
|
1172
|
+
headSha: data.head?.sha,
|
|
1173
|
+
headRef: data.head?.ref,
|
|
1174
|
+
baseRef: data.base?.ref
|
|
1175
|
+
};
|
|
1133
1176
|
}
|
|
1134
1177
|
async createPullRequest(pr) {
|
|
1135
1178
|
const { data } = await this.octokit.rest.pulls.create({ ...this.base, ...pr });
|
|
@@ -3423,7 +3466,7 @@ async function runPipeline(input, config, dryRun, pipelineOptions) {
|
|
|
3423
3466
|
const dir = releaseNotesConfig.file.dir;
|
|
3424
3467
|
info(`Generating release notes \u2192 ${dir}`);
|
|
3425
3468
|
try {
|
|
3426
|
-
const { detectMonorepo } = await import("./aggregator-
|
|
3469
|
+
const { detectMonorepo } = await import("./aggregator-SCGIHWXW.js");
|
|
3427
3470
|
const nested = detectMonorepo(process.cwd()).isMonorepo || contexts.length > 1;
|
|
3428
3471
|
const renderContent = (ctx) => {
|
|
3429
3472
|
if (releaseNotesConfig.templates?.path) {
|
|
@@ -3487,7 +3530,7 @@ async function processInput(inputJson, config, dryRun, pipelineOptions) {
|
|
|
3487
3530
|
return runPipeline(input, config, dryRun, pipelineOptions);
|
|
3488
3531
|
}
|
|
3489
3532
|
async function writeMonorepoFiles(contexts, config, dryRun, fileName, refs) {
|
|
3490
|
-
const { detectMonorepo, writeMonorepoChangelogs } = await import("./aggregator-
|
|
3533
|
+
const { detectMonorepo, writeMonorepoChangelogs } = await import("./aggregator-SCGIHWXW.js");
|
|
3491
3534
|
const cwd = process.cwd();
|
|
3492
3535
|
const detected = detectMonorepo(cwd);
|
|
3493
3536
|
if (!detected.isMonorepo) {
|