@releasekit/notes 0.45.0 → 0.46.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.
@@ -54,14 +54,12 @@ With `enhance + categorize` enabled, the same commits produce:
54
54
 
55
55
  ### Breaking
56
56
 
57
- - **BREAKING** **API rename**: Rename connect() to initialize()
57
+ - **API rename**: Rename connect() to initialize()
58
58
 
59
59
  ### New
60
60
 
61
- **ipc**:
62
-
63
61
  - **Deeplink testing**: Add deep link support via triggerDeeplink()
64
- - Add mock IPC support
62
+ - **ipc**: Add mock IPC support
65
63
 
66
64
  ### Fixed
67
65
 
@@ -81,11 +79,11 @@ Four tasks are available. Any combination can be enabled simultaneously.
81
79
  | Task | What it does | Output location |
82
80
  |------|-------------|-----------------|
83
81
  | `enhance` | Rewrites entry descriptions to be clear and user-facing | `entries[].description` (replaced in-place) |
84
- | `categorize` | Groups entries into semantic categories | `enhanced.categories` in template context |
82
+ | `categorize` | Groups entries into semantic categories | `sections` in template context |
85
83
  | `summarize` | Generates a 2–3 sentence release summary | `enhanced.summary` in template context |
86
84
  | `releaseNotes` | Writes full prose markdown release notes | `enhanced.releaseNotes` / pipeline result |
87
85
 
88
- **Recommended starting point:** Enable `enhance` and `categorize` together. This is the most impactful combination — rewriting and grouping both happen in a single LLM call, and it also unlocks `leadIn` phrases, scope grouping, and breaking change re-routing in the built-in renderer. Add `summarize` or `releaseNotes` when you want prose output for GitHub releases.
86
+ **Recommended starting point:** Enable `enhance` and `categorize` together. This is the most impactful combination — rewriting and grouping both happen in a single LLM call, and it also unlocks `leadIn` phrases and LLM-flagged breaking changes in the built-in renderer. Add `summarize` or `releaseNotes` when you want prose output for GitHub releases.
89
87
 
90
88
  > **Efficiency tip:** When both `enhance` and `categorize` are enabled, the pipeline makes a **single combined LLM call** (`enhanceAndCategorize`) instead of two sequential calls. This combined path also produces `leadIn` phrases and scope assignments, which are not available when running `enhance` alone.
91
89
 
@@ -110,7 +108,7 @@ Entries are processed in parallel. Control the batch size with `concurrency` (de
110
108
 
111
109
  ## Task: `categorize`
112
110
 
113
- Groups entries into user-friendly categories. The result populates `enhanced.categories` in the release-notes template context and drives the section layout of the built-in release notes.
111
+ Groups entries into user-friendly categories. The result populates `sections` in the release-notes template context and drives the section layout of the built-in release notes.
114
112
 
115
113
  ### Default categories
116
114
 
@@ -214,13 +212,11 @@ This is more efficient than two sequential calls and produces richer output. Use
214
212
 
215
213
  ## Breaking change handling
216
214
 
217
- Any entry where `breaking: true` is set — whether from the source input or flagged by the LLM during enhancement — is automatically moved to a `Breaking` category by the built-in markdown renderer 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.
215
+ Any entry where `breaking: true` is set — whether from the source input or flagged by the LLM during enhancement — is automatically moved to a `Breaking` category by the built-in markdown renderer at render time, regardless of which category the LLM assigned it to. The `Breaking` category comes first unless `categoryOrder` places it.
218
216
 
219
217
  This happens in the renderer, not during the LLM call, so custom templates receive the raw data and must implement breaking-change handling themselves if needed.
220
218
 
221
- Rendered format:
222
- - With `leadIn`: `- **BREAKING** **API rename**: Rename connect() to initialize()`
223
- - Without `leadIn`: `- **BREAKING** Rename connect() to initialize()`
219
+ The section marks an entry as breaking, so its line has no prefix: `- **API rename**: Rename connect() to initialize()`.
224
220
 
225
221
  ---
226
222
 
@@ -228,36 +224,16 @@ Rendered format:
228
224
 
229
225
  When running the combined `enhanceAndCategorize` task, the LLM generates a `leadIn` phrase for notable entries — a short noun phrase (e.g. `"Streaming API"`, `"Deeplink testing"`) that makes the entry scannable at a glance.
230
226
 
231
- The LLM sets `leadIn` only for entries that introduce a named API, feature, or concept. Routine fixes, dependency bumps, and internal refactors receive `null` and render without a prefix.
227
+ The LLM sets `leadIn` only for entries that introduce a named API, feature, or concept. Routine fixes, dependency bumps, and internal refactors receive `null` and render with just their scope, if any.
232
228
 
233
229
  Rendered format:
234
230
  - With `leadIn`: `- **Deeplink testing**: Add deep link support via triggerDeeplink()`
235
- - Without `leadIn`: `- Add mock IPC support`
236
- - With `leadIn` + `breaking`: `- **BREAKING** **API rename**: Rename connect() to initialize()`
231
+ - Without `leadIn`: `- **ipc**: Add mock IPC support`, or `- Add mock IPC support` with no scope
237
232
 
238
233
  The `leadIn` value is available in templates as `entry.leadIn` (may be `undefined`).
239
234
 
240
235
  ---
241
236
 
242
- ## Scope grouping
243
-
244
- When the built-in markdown renderer encounters a category where **two or more entries share the same scope**, it groups them under a bold scope header instead of repeating the scope on each bullet:
245
-
246
- ```markdown
247
- ### New
248
-
249
- **ipc**:
250
-
251
- - **Deeplink testing**: Add deep link support via triggerDeeplink()
252
- - Add mock IPC support
253
- ```
254
-
255
- 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.
256
-
257
- Scope is assigned by the LLM (or inherited from the source commit). Control what scopes are valid with the `scopes` config.
258
-
259
- ---
260
-
261
237
  ## Scope validation (`scopes`)
262
238
 
263
239
  Controls how the LLM assigns scopes to entries.
@@ -289,7 +265,7 @@ Invalid scopes trigger a corrective retry — the LLM is told which scopes are v
289
265
 
290
266
  ## PR body context (`context.pullRequests`)
291
267
 
292
- When `context.pullRequests` is `true` (the default), the pipeline fetches the body of each linked pull request from GitHub and includes it in the LLM prompt. This gives the LLM additional context — PR descriptions, linked issues, migration notes — for writing accurate enhanced entries.
268
+ When `context.pullRequests` is `true` (the default), the pipeline fetches the body of each entry's own pull request (the `(#N)` on a squash-merge subject) and includes it in the LLM prompt. This gives the LLM additional context — PR descriptions, linked issues, migration notes — for writing accurate enhanced entries.
293
269
 
294
270
  Requires `GITHUB_TOKEN` or `GH_TOKEN`. If no token is available, PR fetching is silently skipped and a warning is logged.
295
271
 
@@ -340,7 +316,7 @@ The built-in renderer can append a links section at the bottom of each release.
340
316
  Two sources of links can be combined:
341
317
 
342
318
  - **`items`** — static label/URL pairs hardcoded in config
343
- - **`fromPRBodyMarker`** — scans all linked PR bodies for lines starting with the marker string and extracts markdown links or bare URLs from them
319
+ - **`fromPRBodyMarker`** — scans each entry's own PR body for lines starting with the marker string and extracts markdown links or bare URLs from them
344
320
 
345
321
  ```json
346
322
  {
@@ -452,14 +428,12 @@ Note that `links` is a property of `releaseNotes`, not `llm`.
452
428
 
453
429
  ### Breaking
454
430
 
455
- - **BREAKING** **API rename**: Rename connect() to initialize()
431
+ - **API rename**: Rename connect() to initialize()
456
432
 
457
433
  ### New
458
434
 
459
- **ipc**:
460
-
461
435
  - **Deeplink testing**: Add deep link support via triggerDeeplink()
462
- - Add mock IPC support
436
+ - **ipc**: Add mock IPC support
463
437
 
464
438
  ### Fixed
465
439
 
@@ -476,7 +450,7 @@ Note that `links` is a property of `releaseNotes`, not `llm`.
476
450
 
477
451
  **What happened:**
478
452
  - The `refactor!` commit has `breaking: true`, so it was re-routed to `Breaking` regardless of the LLM's original category. The `leadIn` phrase `"API rename"` was generated because it introduces a named API change.
479
- - The two `feat(ipc)` commits share the `ipc` scope, so they're grouped under a `**ipc**:` header. The first gets a `leadIn` (`"Deeplink testing"`); the second is a routine addition and gets none.
453
+ - The first `feat(ipc)` commit gets a `leadIn` (`"Deeplink testing"`), shown in place of its scope; the second is a routine addition and shows its `ipc` scope.
480
454
  - The `fix` commit maps to `Fixed` with no scope or `leadIn` (routine fix).
481
455
  - The `chore` commit maps to `Developer` (internal tooling change).
482
456
  - The static link from `items` is appended under `### Links`.
package/docs/monorepo.md CHANGED
@@ -73,6 +73,47 @@ Custom file name applies to all packages:
73
73
 
74
74
  ---
75
75
 
76
+ ## Project-wide changes
77
+
78
+ Commits that touch no package outside `version.sharedPackages` are project-wide. In async mode (`sync: false`, no `groups`, more than one package in the run):
79
+
80
+ - **Touching a shared package**, such as a bundled core: every released package's changelog, per-version notes file and release body ends with a `### Project-wide changes` block listing the ones since that package's previous release. A shared package's own block leaves out its own commits.
81
+ - **Touching no package**, such as CI or root tooling: only the root changelog lists them.
82
+
83
+ In those releases, the root changelog lists both kinds once per run, after that run's versions:
84
+
85
+ ```markdown
86
+ ## [utils@1.1.0] - 2026-03-15
87
+
88
+ ### Fixed
89
+
90
+ - Memory leak in event handler
91
+
92
+ ## Project-wide changes - 2026-03-15
93
+
94
+ ### Fixed
95
+
96
+ - Pin the bundled zod copy
97
+ ```
98
+
99
+ ---
100
+
101
+ ## Bundled release notes
102
+
103
+ With per-package tags, a releasing package in `version.primaryPackages` gets a section in its release notes and GitHub release body for each of its group-mates and internal dependencies that released changes of their own since the primary's previous release (its previous stable release, if any, for a stable release), in this run or an earlier one. Its internal dependencies are its `dependencies`, `peerDependencies` and cargo path dependencies, followed transitively but not through another primary, which is never bundled.
104
+
105
+ ```markdown
106
+ ### @myorg/utils 1.1.0 → 1.2.0
107
+
108
+ #### Fixed
109
+
110
+ - Memory leak in event handler
111
+ ```
112
+
113
+ Only async and grouped releases bundle, and a primary's first release bundles nothing. Each section groups the package's entries by type, Breaking first. In async mode, `version.sharedPackages` are left out, since their changes are already under Project-wide changes. `CHANGELOG.md` stays per package. `githubRelease.skipPackages` still decides whether a bundled package gets its own release.
114
+
115
+ ---
116
+
76
117
  ## CLI Flags
77
118
 
78
119
  `--changelog-mode` overrides the configured changelog location. Every flag is in the [CLI reference](../../../docs/cli.md#releasekit-notes-generate).
package/docs/templates.md CHANGED
@@ -43,8 +43,8 @@ Pass a directory containing named template files. Each file renders a different
43
43
  ```
44
44
  templates/
45
45
  ├── document.liquid # Outer document wrapper (receives DocumentContext)
46
- ├── version.liquid # One version block (receives TemplateContext)
47
- └── entry.liquid # One changelog entry (receives ChangelogEntry fields directly)
46
+ ├── version.liquid # One version block (receives a Version, as `version` in Liquid)
47
+ └── entry.liquid # One changelog entry (receives an Entry)
48
48
  ```
49
49
 
50
50
  ```bash
@@ -53,16 +53,16 @@ releasekit-notes --template ./templates/
53
53
 
54
54
  All three files are optional — omit any you don't need to customise, and the built-in for that level is used.
55
55
 
56
- The `entry.liquid` template receives the `ChangelogEntry` fields directly as top-level variables: `type`, `description`, `scope`, `breaking`, `issueIds`, `leadIn`.
56
+ An entry template gets one [Entry](#entry). Handlebars and EJS entry templates get its fields directly, as in `{{{line}}}`. A Liquid include shares the caller's variables, so name the `version.liquid` loop variable `entry` and use `{{ entry.line }}`.
57
57
 
58
58
  ### Writing to an existing changelog
59
59
 
60
60
  A changelog template renders only this run's versions, in `versions`. How the output reaches the file:
61
61
 
62
62
  - **New or empty file:** the whole output is written.
63
- - **Existing file:** the output from its first line starting with `## ` goes directly under the file's header, which is everything before the file's first `## ` line. The rest of the file is kept. Anything the template renders before its first `## ` line, such as its own header, is dropped. Everything from that line to the end of the output is inserted on every run, so render only version sections after the header: no footer, such as link reference definitions, and no fixed `## ` section, such as `## [Unreleased]`.
63
+ - **Existing file:** the output from its first version heading goes directly under the file's header, which is everything before the file's first version heading. A version heading is a `# `, `## ` or `### ` heading containing a version outside any link target, such as `## [1.2.0]`, `# [1.2.0](…) (2026-01-01)` or `## [@scope/pkg@1.2.0-next.0]`. `# Changelog` and `## [Unreleased]` aren't, so new versions go below an `## [Unreleased]` section. The rest of the file is kept. Anything the template renders before its first version heading, such as its own header, is dropped. Everything from that heading to the end of the output is inserted on every run, so render only version sections after the header: no footer, such as link reference definitions, and no fixed section, such as `## [Unreleased]`.
64
64
 
65
- So start each version section with a level-2 heading (`## `). If the output has none, an existing file is left unchanged and a warning is logged.
65
+ So start each version section with a version heading. If the output has none, an existing file is left unchanged and a warning is logged.
66
66
 
67
67
  In `packages` and `both` modes, each package's changelog is rendered on its own: `versions` holds only that package's version, and `project.name` is the package name.
68
68
 
@@ -78,9 +78,10 @@ The outermost template (`document`) receives:
78
78
  |----------|------|-------------|
79
79
  | `project.name` | `string` | Repository/package name |
80
80
  | `project.repoUrl` | `string \| null` | Repository URL |
81
- | `versions` | `TemplateContext[]` | All rendered versions, newest first |
82
- | `unreleased` | `TemplateContext \| undefined` | Unreleased changes, if any |
81
+ | `versions` | `Version[]` | All rendered versions, newest first |
82
+ | `unreleased` | `Version \| undefined` | Unreleased changes, if any |
83
83
  | `compareUrls` | `Record<string, string> \| undefined` | Map of version → compare URL for all versions |
84
+ | `shared` | `Section[]` | A root changelog's [project-wide entries](monorepo.md#project-wide-changes) for the run, which the built-in renderer lists after the versions. Empty otherwise |
84
85
  | `perPackage` | `boolean \| undefined` | `true` when rendered inline for a single package (e.g. GitHub release body). Use this to suppress document-level headings that are redundant when the content is embedded in a release that already shows the package name and version. |
85
86
  | `output` | `'file' \| 'release' \| undefined` | Which release-notes destination this render targets: `'file'` (an in-repo per-version file) or `'release'` (the GitHub release body). Branch on it to emit content that only suits one — most importantly, docs-site **YAML frontmatter**, which would render as literal text in a GitHub release. |
86
87
 
@@ -107,8 +108,32 @@ Each version block (`version`) receives:
107
108
  | `date` | `string` | Release date in `YYYY-MM-DD` format |
108
109
  | `repoUrl` | `string \| null` | Repository URL |
109
110
  | `compareUrl` | `string \| undefined` | Link to diff between previous and current version |
110
- | `entries` | `ChangelogEntry[]` | Changelog entries. Release-notes templates get the LLM-rewritten entries when `tasks.enhance` is on; changelog templates always get the commit-derived ones |
111
- | `enhanced` | `EnhancedData \| undefined` | LLM-processed data (see below) |
111
+ | `entries` | `Entry[]` | Changelog entries in commit order. Release-notes templates get the LLM-rewritten entries when `tasks.enhance` is on; changelog templates always get the commit-derived ones |
112
+ | `sections` | `Section[]` | The same entries grouped as the built-in renderer groups them (see below) |
113
+ | `shared` | `Section[]` | [Shared-package entries](monorepo.md#project-wide-changes) in commit-type groups, which the built-in renderer lists under `### Project-wide changes` after the version's own. Empty in a root changelog |
114
+ | `bundled` | `Bundled[]` | A primary's [bundled packages](monorepo.md#bundled-release-notes), each with `packageName`, `version`, `firstVersion` (when it released more than once) and `sections`. Release notes only: empty in a changelog |
115
+ | `enhanced` | `object \| undefined` | LLM-written text (see below) |
116
+
117
+ ### Sections
118
+
119
+ Each section in `sections` has a `label` and its `entries`, in this order:
120
+
121
+ 1. `Breaking`, holding every breaking entry. With LLM categories, `categoryOrder` can place it later.
122
+ 2. With the `categorize` task on a release-notes template, the LLM categories, ordered by `categoryOrder`. Otherwise the commit types, labelled `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed` and `Security`, in that order.
123
+ 3. Without LLM categories, `Dependencies & version bumps`, holding non-breaking `deps` and `deps-dev` entries.
124
+
125
+ Empty sections are left out. To use your own heading, match the label:
126
+
127
+ ```liquid
128
+ {% for section in version.sections %}
129
+ ### {% if section.label == "Added" %}New{% else %}{{ section.label }}{% endif %}
130
+ {% for entry in section.entries %}
131
+ {{ entry.line }}
132
+ {% endfor %}
133
+ {% endfor %}
134
+ ```
135
+
136
+ A breaking entry is marked by its section, not its line. A template that lists the flat `entries` has to check `entry.breaking` itself.
112
137
 
113
138
  ### Entry
114
139
 
@@ -122,35 +147,28 @@ Each entry in `entries` has:
122
147
  | `breaking` | `boolean \| undefined` | `true` for breaking changes. Combined `enhanceAndCategorize` can also set it. |
123
148
  | `issueIds` | `string[] \| undefined` | Referenced issue/PR numbers |
124
149
  | `leadIn` | `string \| undefined` | Short scannable phrase for notable entries (e.g. `"Streaming API"`). Set by the LLM during `enhance` or combined `enhanceAndCategorize`. `undefined` for routine entries. |
150
+ | `line` | `string` | The built-in renderer's Markdown line: `- **scope**: description (refs)`, with the lead-in in the scope's place and refs rendered per `notes.changelog.refs` |
151
+
152
+ `line` has `@` mentions and `<!--` comment openers escaped; the other fields are raw commit or LLM text. Print it without the engine's HTML escaping: `{{{ line }}}` in Handlebars, `<%- line %>` in EJS. Liquid doesn't escape.
125
153
 
126
154
  ### Enhanced data (`enhanced`)
127
155
 
128
- Present in release-notes templates when any LLM task ran successfully. Changelog templates never get it:
156
+ Present in release-notes templates when the `summarize` or `releaseNotes` task produced text. Changelog templates never get it:
129
157
 
130
158
  | Field | Type | Description |
131
159
  |-------|------|-------------|
132
160
  | `enhanced.summary` | `string \| undefined` | 2–3 sentence release summary (`summarize` task) |
133
- | `enhanced.categories` | `Category[] \| undefined` | Grouped entries (`categorize` task) |
134
161
  | `enhanced.releaseNotes` | `string \| undefined` | Full prose release notes (`releaseNotes` task) |
135
162
 
136
- Each `Category` in `enhanced.categories`:
137
-
138
- | Field | Type | Description |
139
- |-------|------|-------------|
140
- | `name` | `string` | Category display name |
141
- | `entries` | `ChangelogEntry[]` | Entries in this category (same type as `entries`; may have `leadIn`, `scope`, `breaking` populated by the LLM) |
142
-
143
- Entries within `enhanced.categories` are the same `ChangelogEntry` objects as in `entries`, with all LLM-assigned fields populated. Custom templates can access `entry.leadIn`, `entry.scope`, and `entry.breaking` directly.
163
+ The `categorize` task's categories come through `sections`.
144
164
 
145
165
  ### Built-in renderer behaviour
146
166
 
147
- When no custom template is configured, the built-in markdown renderer applies the following transformations to LLM-categorised output. Custom templates receive the raw data and must implement these behaviours themselves if desired.
148
-
149
- **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.
167
+ When no custom template is configured, the built-in markdown renderer applies the following transformations to LLM-categorised output. Templates get the same grouping in `sections`.
150
168
 
151
- **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.
169
+ **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. See [Sections](#sections) for the order.
152
170
 
153
- **`leadIn` prefix:** Entries with a `leadIn` value render as `**leadIn**: description`. Combined with `breaking: true`, the format is `**BREAKING** **leadIn**: description`.
171
+ **`leadIn` prefix:** Entries with a `leadIn` value render as `**leadIn**: description`, in place of the scope.
154
172
 
155
173
  **Links section:** When `notes.releaseNotes.links` is configured, a links section is appended after all categories. This section is only rendered in the LLM-categorised path.
156
174
 
@@ -176,31 +194,13 @@ When no custom template is configured, the built-in markdown renderer applies th
176
194
  ### Liquid (composable — `version.liquid`)
177
195
 
178
196
  ```liquid
179
- ## [{{ version }}]({{ compareUrl }}) — {{ date }}
180
-
181
- {% if enhanced.categories %}
182
- {% for cat in enhanced.categories %}
183
- ### {{ cat.name }}
184
-
185
- {% for entry in cat.entries %}
186
- {% if entry.breaking and entry.leadIn %}
187
- - **BREAKING** **{{ entry.leadIn }}**: {{ entry.description }}
188
- {% elsif entry.breaking %}
189
- - **BREAKING** {{ entry.description }}
190
- {% elsif entry.leadIn %}
191
- - **{{ entry.leadIn }}**: {{ entry.description }}
192
- {% elsif entry.scope %}
193
- - **{{ entry.scope }}**: {{ entry.description }}
194
- {% else %}
195
- - {{ entry.description }}
196
- {% endif %}
197
- {% endfor %}
197
+ ## [{{ version.version }}]({{ version.compareUrl }}) — {{ version.date }}
198
+ {% for section in version.sections %}
199
+ ### {{ section.label }}
200
+ {% for entry in section.entries %}
201
+ {{ entry.line }}
198
202
  {% endfor %}
199
- {% else %}
200
- {% for entry in entries %}
201
- - {{ entry.description }}
202
203
  {% endfor %}
203
- {% endif %}
204
204
  ```
205
205
 
206
206
  ### Handlebars (`version.hbs`)
@@ -209,24 +209,33 @@ When no custom template is configured, the built-in markdown renderer applies th
209
209
  ## [{{version}}] — {{date}}
210
210
 
211
211
  {{#if enhanced.summary}}
212
- > {{enhanced.summary}}
212
+ > {{{enhanced.summary}}}
213
213
 
214
214
  {{/if}}
215
+ {{#each sections}}
216
+ ### {{{label}}}
217
+
215
218
  {{#each entries}}
216
- - **{{type}}**: {{description}}
219
+ {{{line}}}
220
+ {{/each}}
221
+
217
222
  {{/each}}
218
223
  ```
219
224
 
220
- ### EJS (`release.md.ejs`)
225
+ ### EJS (composable — `version.ejs`)
221
226
 
222
227
  ```ejs
223
228
  ## <%= version %> — <%= date %>
224
229
 
225
230
  <% if (enhanced && enhanced.releaseNotes) { %>
226
- <%= enhanced.releaseNotes %>
231
+ <%- enhanced.releaseNotes %>
227
232
  <% } else { %>
228
- <% entries.forEach(entry => { %>
229
- - **<%= entry.type %>**: <%= entry.description %>
233
+ <% sections.forEach(section => { %>
234
+ ### <%- section.label %>
235
+
236
+ <% section.entries.forEach(entry => { %>
237
+ <%- entry.line %>
238
+ <% }) %>
230
239
  <% }) %>
231
240
  <% } %>
232
241
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@releasekit/notes",
3
- "version": "0.45.0",
3
+ "version": "0.46.1",
4
4
  "description": "Changelog and release notes generation with flexible templating and optional LLM-enhanced release notes",
5
5
  "type": "module",
6
6
  "module": "./dist/index.js",
@@ -5,3 +5,15 @@ All notable changes to this project will be documented in this file.
5
5
  {{#each versions}}
6
6
  {{> version}}
7
7
  {{/each}}
8
+ {{#if shared.length}}
9
+ ## Project-wide changes - {{versions.[0].date}}
10
+
11
+ {{#each shared}}
12
+ ### {{{label}}}
13
+
14
+ {{#each entries}}
15
+ {{{line}}}
16
+ {{/each}}
17
+
18
+ {{/each}}
19
+ {{/if}}
@@ -1,2 +1 @@
1
- - {{#if breaking}}**BREAKING** {{/if}}{{#if scope}}**{{scope}}**: {{/if}}{{description}}{{#if issueIds}} ({{join issueIds ", "}}){{/if}}
2
-
1
+ {{{line}}}
@@ -3,13 +3,23 @@
3
3
  [Full Changelog]({{compareUrl}})
4
4
  {{/if}}
5
5
 
6
+ {{#each sections}}
7
+ ### {{{label}}}
8
+
6
9
  {{#each entries}}
7
- {{#if breaking}}
8
10
  {{> entry}}
9
- {{/if}}
10
11
  {{/each}}
12
+
13
+ {{/each}}
14
+ {{#if shared.length}}
15
+ ### Project-wide changes
16
+
17
+ {{#each shared}}
18
+ #### {{{label}}}
19
+
11
20
  {{#each entries}}
12
- {{#unless breaking}}
13
21
  {{> entry}}
14
- {{/unless}}
15
22
  {{/each}}
23
+
24
+ {{/each}}
25
+ {{/if}}
@@ -1,20 +1,45 @@
1
1
  ## What's Changed
2
+ <% if (versions.length > 0) { -%>
3
+ <% const version = versions[0]; -%>
4
+ <% if (version.enhanced?.releaseNotes) { -%>
2
5
 
3
- <% if (versions.length > 0) { %>
4
- <% const version = versions[0]; %>
6
+ <%- version.enhanced.releaseNotes %>
7
+ <% } else { -%>
8
+ <% version.sections.forEach(function(section) { -%>
5
9
 
6
- <% if (version.enhanced?.releaseNotes) { %>
7
- <%= version.enhanced.releaseNotes %>
8
- <% } else { %>
9
- <% if (version.entries.length > 0) { %>
10
- <% [...version.entries.filter((e) => e.breaking), ...version.entries.filter((e) => !e.breaking)].forEach(function(entry) { %>
11
- - <% if (entry.breaking) { %>**BREAKING** <% } %><% if (entry.scope) { %>**<%= entry.scope %>**: <% } %><%= entry.description %><% if (entry.issueIds) { %> (<%= entry.issueIds.join(', ') %>)<% } %>
10
+ ### <%- section.label %>
12
11
 
13
- <% }); %>
14
- <% } %>
15
- <% } %>
12
+ <% section.entries.forEach(function(entry) { -%>
13
+ <%- entry.line %>
14
+ <% }); -%>
15
+ <% }); -%>
16
+ <% } -%>
17
+ <% if (version.shared.length > 0) { -%>
16
18
 
17
- <% if (version.compareUrl) { %>
18
- **Full Changelog**: <%= version.compareUrl %>
19
- <% } %>
20
- <% } %>
19
+ ### Project-wide changes
20
+ <% version.shared.forEach(function(section) { -%>
21
+
22
+ #### <%- section.label %>
23
+
24
+ <% section.entries.forEach(function(entry) { -%>
25
+ <%- entry.line %>
26
+ <% }); -%>
27
+ <% }); -%>
28
+ <% } -%>
29
+ <% version.bundled.forEach(function(pkg) { -%>
30
+
31
+ ### <%- pkg.packageName %> <% if (pkg.firstVersion) { %><%- pkg.firstVersion %> → <% } %><%- pkg.version %>
32
+ <% pkg.sections.forEach(function(section) { -%>
33
+
34
+ #### <%- section.label %>
35
+
36
+ <% section.entries.forEach(function(entry) { -%>
37
+ <%- entry.line %>
38
+ <% }); -%>
39
+ <% }); -%>
40
+ <% }); -%>
41
+ <% if (version.compareUrl) { -%>
42
+
43
+ **Full Changelog**: <%- version.compareUrl %>
44
+ <% } -%>
45
+ <% } -%>
@@ -8,3 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8
8
  {% for version in versions %}
9
9
  {% include "version" %}
10
10
  {% endfor %}
11
+ {%- if shared.size > 0 %}
12
+
13
+ ## Project-wide changes - {{ versions.first.date }}
14
+ {%- for section in shared %}
15
+
16
+ ### {{ section.label }}
17
+ {% for entry in section.entries %}
18
+ {{ entry.line }}
19
+ {%- endfor %}
20
+ {%- endfor %}
21
+ {%- endif %}
@@ -1,2 +1 @@
1
- - {% if entry.breaking %}**BREAKING** {% endif %}{% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
2
-
1
+ {{ entry.line -}}
@@ -1,56 +1,23 @@
1
- ## [{{ version.version }}]{% if version.previousVersion %}{% endif %} - {{ version.date }}
2
- {% if version.compareUrl %}
3
- [Full Changelog]({{ version.compareUrl }})
4
- {% endif %}
1
+ ## [{{ version.version }}] - {{ version.date }}
2
+ {%- if version.compareUrl %}
5
3
 
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" %}
4
+ [Full Changelog]({{ version.compareUrl }})
5
+ {%- endif %}
6
+ {%- for section in version.sections %}
14
7
 
15
- {% if breaking.size > 0 %}
16
- ### Breaking
17
- {% for entry in breaking %}
18
- {% include "entry" %}
19
- {% endfor %}
20
- {% endif %}
21
- {% if added.size > 0 %}
22
- ### Added
23
- {% for entry in added %}
24
- {% include "entry" %}
25
- {% endfor %}
26
- {% endif %}
27
- {% if changed.size > 0 %}
28
- ### Changed
29
- {% for entry in changed %}
30
- {% include "entry" %}
31
- {% endfor %}
32
- {% endif %}
33
- {% if deprecated.size > 0 %}
34
- ### Deprecated
35
- {% for entry in deprecated %}
8
+ ### {{ section.label }}
9
+ {% for entry in section.entries %}
36
10
  {% include "entry" %}
37
- {% endfor %}
38
- {% endif %}
39
- {% if removed.size > 0 %}
40
- ### Removed
41
- {% for entry in removed %}
42
- {% include "entry" %}
43
- {% endfor %}
44
- {% endif %}
45
- {% if fixed.size > 0 %}
46
- ### Fixed
47
- {% for entry in fixed %}
48
- {% include "entry" %}
49
- {% endfor %}
50
- {% endif %}
51
- {% if security.size > 0 %}
52
- ### Security
53
- {% for entry in security %}
11
+ {%- endfor %}
12
+ {%- endfor %}
13
+ {%- if version.shared.size > 0 %}
14
+
15
+ ### Project-wide changes
16
+ {%- for section in version.shared %}
17
+
18
+ #### {{ section.label }}
19
+ {% for entry in section.entries %}
54
20
  {% include "entry" %}
55
- {% endfor %}
56
- {% endif %}
21
+ {%- endfor %}
22
+ {%- endfor %}
23
+ {%- endif %}