@releasekit/notes 0.43.0 → 0.44.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.
@@ -4,7 +4,7 @@ import {
4
4
  prependVersions,
5
5
  renderMarkdown,
6
6
  success
7
- } from "./chunk-TNTTAFQ4.js";
7
+ } from "./chunk-ECBA67PM.js";
8
8
 
9
9
  // src/monorepo/aggregator.ts
10
10
  import * as fs from "fs";
package/dist/cli.js CHANGED
@@ -1,10 +1,10 @@
1
1
  #!/usr/bin/env node
2
2
  import {
3
3
  createNotesCommand
4
- } from "./chunk-U5JUUEEQ.js";
4
+ } from "./chunk-UAPJMRGO.js";
5
5
  import {
6
6
  readPackageVersion
7
- } from "./chunk-TNTTAFQ4.js";
7
+ } from "./chunk-ECBA67PM.js";
8
8
 
9
9
  // src/cli.ts
10
10
  import * as fs from "fs";
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@ import 'commander';
5
5
  declare const MonorepoConfigSchema: z.ZodObject<{
6
6
  rootPath: z.ZodOptional<z.ZodString>;
7
7
  packagesPath: z.ZodOptional<z.ZodString>;
8
- }, z.core.$strip>;
8
+ }, z.core.$strict>;
9
9
  type MonorepoConfig = z.infer<typeof MonorepoConfigSchema>;
10
10
  declare function loadAuth(): Record<string, string>;
11
11
  declare function saveAuth(provider: string, apiKey: string): void;
@@ -49,6 +49,8 @@ interface VersionPackageChangelog {
49
49
  revisionRange: string;
50
50
  repoUrl: string | null;
51
51
  entries: VersionChangelogEntry[];
52
+ /** The tag this changelog releases: the package's own, or a sync release's shared one. Absent in older manifests. */
53
+ tag?: string;
52
54
  }
53
55
  /** `'graduated'`: a prerelease promoted to stable, ignoring any requested bump. `'first-release'`: no prior tag. */
54
56
  type VersionAction = 'first-release' | 'graduated' | 'bumped';
@@ -74,6 +76,11 @@ interface VersionOutput {
74
76
  * been force-moved off it.
75
77
  */
76
78
  baselineTags?: string[];
79
+ /**
80
+ * Files the version step wrote that no update names, such as the `Cargo.toml` of a non-releasing crate that depends
81
+ * on a releasing crate. Absent when there are none, and in older manifests.
82
+ */
83
+ additionalFiles?: string[];
77
84
  }
78
85
  interface VersionPackageUpdate {
79
86
  packageName: string;
@@ -143,6 +150,7 @@ interface PackageChangelog {
143
150
  packageName: string;
144
151
  version: string;
145
152
  previousVersion: string | null;
153
+ tag?: string;
146
154
  revisionRange: string;
147
155
  repoUrl: string | null;
148
156
  date: string;
@@ -245,7 +253,7 @@ interface TemplateConfig {
245
253
  }
246
254
  interface LLMConfig {
247
255
  provider: 'openai' | 'openai-compatible' | 'anthropic' | 'ollama';
248
- model: string;
256
+ model?: string;
249
257
  baseURL?: string;
250
258
  apiKey?: string;
251
259
  options?: {
@@ -367,7 +375,7 @@ declare class ConfigError extends NotesError {
367
375
  }
368
376
  declare function getExitCode(error: NotesError): number;
369
377
 
370
- declare function versionOutputToChangelogInput(data: Pick<VersionOutput, 'changelogs'>): ChangelogInput;
378
+ declare function versionOutputToChangelogInput(data: Pick<VersionOutput, 'changelogs'> & Partial<Pick<VersionOutput, 'updates' | 'tags'>>): ChangelogInput;
371
379
  declare function parseVersionOutput(json: string): ChangelogInput;
372
380
  declare function parseVersionOutputFile(filePath: string): ChangelogInput;
373
381
  declare function parseVersionOutputStdin(): Promise<ChangelogInput>;
package/dist/index.js CHANGED
@@ -19,12 +19,12 @@ import {
19
19
  runPipeline,
20
20
  saveAuth,
21
21
  versionOutputToChangelogInput
22
- } from "./chunk-U5JUUEEQ.js";
22
+ } from "./chunk-UAPJMRGO.js";
23
23
  import {
24
24
  aggregateToRoot,
25
25
  detectMonorepo,
26
26
  writeMonorepoChangelogs
27
- } from "./chunk-YNGSEWF6.js";
27
+ } from "./chunk-ZY4HXAQV.js";
28
28
  import {
29
29
  debug,
30
30
  formatVersion,
@@ -32,7 +32,7 @@ import {
32
32
  renderMarkdown,
33
33
  success,
34
34
  writeMarkdown
35
- } from "./chunk-TNTTAFQ4.js";
35
+ } from "./chunk-ECBA67PM.js";
36
36
 
37
37
  // src/output/json.ts
38
38
  import * as fs from "fs";
@@ -202,7 +202,7 @@ You do not need `mode` or `file` configured for this task — the generated text
202
202
 
203
203
  ### Links section
204
204
 
205
- When LLM categorisation is active, you can configure the built-in renderer to append a links section (migration guides, changelogs, etc.) to each release. This is configured on `notes.releaseNotes.links`, not inside `llm`. See [notes.releaseNotes.links](./configuration.md#notesreleasenoteslinks) in the configuration reference.
205
+ When LLM categorisation is active, you can configure the built-in renderer to append a links section (migration guides, changelogs, etc.) to each release. It's configured on [`notes.releaseNotes.links`](../../../docs/configuration.md#notesreleasenoteslinks), not inside `llm`.
206
206
 
207
207
  ---
208
208
 
@@ -255,26 +255,12 @@ If you need fully custom output formatting, use the [templates system](./templat
255
255
 
256
256
  ## CLI Flags
257
257
 
258
- LLM options can also be set via CLI flags without a config file:
258
+ The `--llm-*` flags set LLM options without a config file. Every flag is in the [CLI reference](../../../docs/cli.md#releasekit-notes-generate).
259
259
 
260
260
  ```bash
261
261
  releasekit-notes \
262
+ --input version-output.json \
262
263
  --llm-provider anthropic \
263
264
  --llm-model claude-haiku-4-5 \
264
- --llm-tasks enhance,release-notes \
265
- --input version-output.json
266
- ```
267
-
268
- > **Task name format:** CLI flags use kebab-case (`release-notes`), while the config file uses camelCase (`releaseNotes`). The mapping is: `enhance` → `enhance`, `categorize` → `categorize`, `summarize` → `summarize`, `releaseNotes` → `release-notes`.
269
-
270
- Use `--no-llm` to disable LLM processing even when it is configured:
271
-
272
- ```bash
273
- releasekit-notes --no-llm
274
- ```
275
-
276
- Use `--no-release-notes` to disable release notes entirely (including LLM):
277
-
278
- ```bash
279
- releasekit-notes --no-release-notes
265
+ --llm-tasks enhance,release-notes
280
266
  ```
@@ -34,13 +34,16 @@ Without LLM, the built-in renderer groups entries by their conventional commit t
34
34
  ## [2.0.0] - 2026-01-15
35
35
 
36
36
  ### Changed
37
+
37
38
  - rename connect() to initialize() across public API
38
39
 
39
40
  ### Added
41
+
40
42
  - add triggerDeeplink() for deep link testing
41
43
  - add mock IPC handler support
42
44
 
43
45
  ### Fixed
46
+
44
47
  - null pointer in renderer process memory management
45
48
  ```
46
49
 
@@ -50,14 +53,18 @@ With `enhance + categorize` enabled, the same commits produce:
50
53
  ## [2.0.0] - 2026-01-15
51
54
 
52
55
  ### Breaking
56
+
53
57
  - **BREAKING** **API rename**: Rename connect() to initialize()
54
58
 
55
59
  ### New
60
+
56
61
  **ipc**:
62
+
57
63
  - **Deeplink testing**: Add deep link support via triggerDeeplink()
58
64
  - Add mock IPC support
59
65
 
60
66
  ### Fixed
67
+
61
68
  - Resolve memory leak in renderer process
62
69
  ```
63
70
 
@@ -236,12 +243,14 @@ When the built-in markdown renderer encounters a category where **two or more en
236
243
 
237
244
  ```markdown
238
245
  ### New
246
+
239
247
  **ipc**:
248
+
240
249
  - **Deeplink testing**: Add deep link support via triggerDeeplink()
241
250
  - Add mock IPC support
242
251
  ```
243
252
 
244
- A scope that appears on only one entry renders inline: `- **scope**: description`. Entries with no scope render as plain bullets.
253
+ A scope that appears on only one entry renders inline: `- **scope**: description`. Entries with no scope render as plain bullets. Both come before the scope groups, so no entry sits under a label it doesn't have.
245
254
 
246
255
  Scope is assigned by the LLM (or inherited from the source commit). Control what scopes are valid with the `scopes` config.
247
256
 
@@ -351,6 +360,7 @@ Rendered output:
351
360
 
352
361
  ```markdown
353
362
  ### Migration guide
363
+
354
364
  - [v2.0 migration](https://docs.example.com/migrate-v2)
355
365
  - [Full guide](https://docs.example.com/full-guide)
356
366
  ```
@@ -439,20 +449,26 @@ Note that `links` is a property of `releaseNotes`, not `llm`.
439
449
  ## [2.0.0] - 2026-01-15
440
450
 
441
451
  ### Breaking
452
+
442
453
  - **BREAKING** **API rename**: Rename connect() to initialize()
443
454
 
444
455
  ### New
456
+
445
457
  **ipc**:
458
+
446
459
  - **Deeplink testing**: Add deep link support via triggerDeeplink()
447
460
  - Add mock IPC support
448
461
 
449
462
  ### Fixed
463
+
450
464
  - Resolve memory leak in renderer process
451
465
 
452
466
  ### Developer
467
+
453
468
  - Migrate bundler to esbuild 0.20
454
469
 
455
470
  ### Links
471
+
456
472
  - [v2.0 migration guide](https://docs.example.com/migrate-v2)
457
473
  ```
458
474
 
package/docs/monorepo.md CHANGED
@@ -39,11 +39,13 @@ In `"root"` or `"both"` mode, the root changelog aggregates entries from all pac
39
39
  ## [@myorg/core@2.0.0] — 2026-03-15
40
40
 
41
41
  ### Added
42
+
42
43
  - New streaming API
43
44
 
44
45
  ## [utils@1.1.0] — 2026-03-15
45
46
 
46
47
  ### Fixed
48
+
47
49
  - Memory leak in event handler
48
50
  ```
49
51
 
@@ -73,27 +75,12 @@ Custom file name applies to all packages:
73
75
 
74
76
  ## CLI Flags
75
77
 
76
- Use `--changelog-mode` to override the changelog location, and `--release-notes-dir` to write per-version release-notes files:
78
+ `--changelog-mode` overrides the configured changelog location. Every flag is in the [CLI reference](../../../docs/cli.md#releasekit-notes-generate).
77
79
 
78
80
  ```bash
79
- # Root changelog only
80
- releasekit-notes --changelog-mode root
81
-
82
- # Per-package changelogs
83
81
  releasekit-notes --changelog-mode packages
84
-
85
- # Both
86
- releasekit-notes --changelog-mode both
87
-
88
- # Use --monorepo as a shorthand for the changelog mode
89
- releasekit-notes --monorepo packages
90
-
91
- # Per-version release-notes files
92
- releasekit-notes --release-notes-dir release-notes
93
82
  ```
94
83
 
95
- `--monorepo` sets the changelog mode (release notes use a per-version directory, not modes). An explicit `--changelog-mode` takes priority over `--monorepo` when both are present.
96
-
97
84
  ---
98
85
 
99
86
  ## Monorepo Path Configuration
package/docs/templates.md CHANGED
@@ -138,7 +138,7 @@ When no custom template is configured, the built-in markdown renderer applies th
138
138
 
139
139
  **Scope grouping:** Within a category, entries sharing the same scope value (two or more) are rendered under a `**scope**:` group header. Entries with a unique scope render with the scope inline (`**scope**: description`). Entries with no scope render as plain bullets.
140
140
 
141
- **Breaking change re-routing:** Any entry with `breaking: true` is moved to a `Breaking` category at render time, regardless of which category the LLM assigned it to. If no `Breaking` category exists, one is created and prepended before all other categories.
141
+ **Breaking change re-routing:** Any entry with `breaking: true` is moved to a `Breaking` category at render time, regardless of which category the LLM assigned it to. If no `Breaking` category exists, one is created and prepended before all other categories. Output without LLM categories gets the same leading `Breaking` section.
142
142
 
143
143
  **`leadIn` prefix:** Entries with a `leadIn` value render as `**leadIn**: description`. Combined with `breaking: true`, the format is `**BREAKING** **leadIn**: description`.
144
144
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@releasekit/notes",
3
- "version": "0.43.0",
3
+ "version": "0.44.0",
4
4
  "description": "Release notes and changelog generation with LLM-powered enhancement and flexible templating",
5
5
  "type": "module",
6
6
  "module": "./dist/index.js",
@@ -47,32 +47,32 @@
47
47
  "access": "public"
48
48
  },
49
49
  "dependencies": {
50
- "@anthropic-ai/sdk": "^1.0.0",
50
+ "@anthropic-ai/sdk": "^1.6.0",
51
51
  "@octokit/rest": "^22.0.1",
52
52
  "chalk": "^6.0.1",
53
- "commander": "^15.0.0",
53
+ "commander": "^15.1.0",
54
54
  "ejs": "^7.0.2",
55
55
  "handlebars": "^4.7.10",
56
56
  "jsonc-parser": "^3.3.1",
57
- "liquidjs": "^10.30.0",
58
- "minimatch": "^10.2.6",
59
- "openai": "^7.41.0",
57
+ "liquidjs": "^10.30.1",
58
+ "minimatch": "^11.0.5",
59
+ "openai": "^7.53.0",
60
60
  "smol-toml": "^1.9.0",
61
61
  "yaml": "^2.9.1",
62
62
  "zod": "^4.6.7"
63
63
  },
64
64
  "devDependencies": {
65
- "@biomejs/biome": "^2.6.2",
65
+ "@biomejs/biome": "^2.6.6",
66
66
  "@releasekit/config": "0.0.0",
67
67
  "@releasekit/core": "0.0.0",
68
68
  "@releasekit/forge": "0.0.0",
69
69
  "@releasekit/git": "0.0.0",
70
70
  "@types/ejs": "^3.1.5",
71
- "@types/node": "^26.6.5",
72
- "@vitest/coverage-v8": "^5.0.5",
71
+ "@types/node": "^26.6.6",
72
+ "@vitest/coverage-v8": "^5.1.0",
73
73
  "tsup": "^9.0.0",
74
74
  "typescript": "^6.0.3",
75
- "vitest": "^5.0.5"
75
+ "vitest": "^5.1.0"
76
76
  },
77
77
  "engines": {
78
78
  "node": ">=22.12"
@@ -4,5 +4,12 @@
4
4
  {{/if}}
5
5
 
6
6
  {{#each entries}}
7
+ {{#if breaking}}
7
8
  {{> entry}}
9
+ {{/if}}
10
+ {{/each}}
11
+ {{#each entries}}
12
+ {{#unless breaking}}
13
+ {{> entry}}
14
+ {{/unless}}
8
15
  {{/each}}
@@ -7,7 +7,7 @@
7
7
  <%= version.enhanced.releaseNotes %>
8
8
  <% } else { %>
9
9
  <% if (version.entries.length > 0) { %>
10
- <% version.entries.forEach(function(entry) { %>
10
+ <% [...version.entries.filter((e) => e.breaking), ...version.entries.filter((e) => !e.breaking)].forEach(function(entry) { %>
11
11
  - <% if (entry.breaking) { %>**BREAKING** <% } %><% if (entry.scope) { %>**<%= entry.scope %>**: <% } %><%= entry.description %><% if (entry.issueIds) { %> (<%= entry.issueIds.join(', ') %>)<% } %>
12
12
 
13
13
  <% }); %>
@@ -3,52 +3,54 @@
3
3
  [Full Changelog]({{ version.compareUrl }})
4
4
  {% endif %}
5
5
 
6
- {% assign added = version.entries | where: "type", "added" %}
7
- {% assign changed = version.entries | where: "type", "changed" %}
8
- {% assign deprecated = version.entries | where: "type", "deprecated" %}
9
- {% assign removed = version.entries | where: "type", "removed" %}
10
- {% assign fixed = version.entries | where: "type", "fixed" %}
11
- {% assign security = version.entries | where: "type", "security" %}
12
-
6
+ {% assign breaking = version.entries | where: "breaking" %}
7
+ {% assign nonBreaking = version.entries | reject: "breaking" %}
8
+ {% assign added = nonBreaking | where: "type", "added" %}
9
+ {% assign changed = nonBreaking | where: "type", "changed" %}
10
+ {% assign deprecated = nonBreaking | where: "type", "deprecated" %}
11
+ {% assign removed = nonBreaking | where: "type", "removed" %}
12
+ {% assign fixed = nonBreaking | where: "type", "fixed" %}
13
+ {% assign security = nonBreaking | where: "type", "security" %}
14
+
15
+ {% if breaking.size > 0 %}
16
+ ### Breaking
17
+ {% for entry in breaking %}
18
+ {% include "entry" %}
19
+ {% endfor %}
20
+ {% endif %}
13
21
  {% if added.size > 0 %}
14
22
  ### Added
15
23
  {% for entry in added %}
16
- - {% if entry.breaking %}**BREAKING** {% endif %}{% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
17
-
24
+ {% include "entry" %}
18
25
  {% endfor %}
19
26
  {% endif %}
20
27
  {% if changed.size > 0 %}
21
28
  ### Changed
22
29
  {% for entry in changed %}
23
- - {% if entry.breaking %}**BREAKING** {% endif %}{% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
24
-
30
+ {% include "entry" %}
25
31
  {% endfor %}
26
32
  {% endif %}
27
33
  {% if deprecated.size > 0 %}
28
34
  ### Deprecated
29
35
  {% for entry in deprecated %}
30
- - {% if entry.breaking %}**BREAKING** {% endif %}{% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
31
-
36
+ {% include "entry" %}
32
37
  {% endfor %}
33
38
  {% endif %}
34
39
  {% if removed.size > 0 %}
35
40
  ### Removed
36
41
  {% for entry in removed %}
37
- - {% if entry.breaking %}**BREAKING** {% endif %}{% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
38
-
42
+ {% include "entry" %}
39
43
  {% endfor %}
40
44
  {% endif %}
41
45
  {% if fixed.size > 0 %}
42
46
  ### Fixed
43
47
  {% for entry in fixed %}
44
- - {% if entry.breaking %}**BREAKING** {% endif %}{% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
45
-
48
+ {% include "entry" %}
46
49
  {% endfor %}
47
50
  {% endif %}
48
51
  {% if security.size > 0 %}
49
52
  ### Security
50
53
  {% for entry in security %}
51
- - {% if entry.breaking %}**BREAKING** {% endif %}{% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
52
-
54
+ {% include "entry" %}
53
55
  {% endfor %}
54
56
  {% endif %}