@releasekit/notes 0.25.0 → 0.27.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/README.md +2 -4
- package/dist/{chunk-NSKMI5F2.js → chunk-RASPVTWN.js} +390 -318
- package/dist/cli.js +1 -1
- package/dist/index.js +1 -1
- package/docs/configuration.md +22 -12
- package/docs/llm-release-notes.md +1 -1
- package/docs/monorepo.md +24 -13
- package/package.json +6 -5
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ Generates CHANGELOG.md and release notes from `@releasekit/version` output, with
|
|
|
14
14
|
- 🤖 **LLM enhancement** (optional) — enhance descriptions, summarize, categorize, or generate prose release notes
|
|
15
15
|
- 🎨 **Flexible templating** — Liquid, Handlebars, or EJS; single-file or composable layout
|
|
16
16
|
- 📦 **Monorepo support** — root aggregation, per-package changelogs, or both
|
|
17
|
-
- 🔀 **
|
|
17
|
+
- 🔀 **Changelog + release notes** — a cumulative `CHANGELOG.md` and per-release notes (GitHub release body, or opt-in per-version files), configured independently
|
|
18
18
|
- 🔍 **Dry-run mode** — preview without writing files
|
|
19
19
|
|
|
20
20
|
## Installation
|
|
@@ -62,8 +62,7 @@ releasekit-notes --input version-data.json \
|
|
|
62
62
|
| `--changelog-mode <mode>` | Changelog location: `root`, `packages`, `both` | `root` |
|
|
63
63
|
| `--changelog-file <name>` | Changelog file name override | `CHANGELOG.md` |
|
|
64
64
|
| `--no-changelog` | Disable changelog generation | — |
|
|
65
|
-
| `--release-notes-
|
|
66
|
-
| `--release-notes-file <name>` | Release notes file name override | `RELEASE_NOTES.md` |
|
|
65
|
+
| `--release-notes-dir <dir>` | Write per-version release-notes files to this directory | — |
|
|
67
66
|
| `--no-release-notes` | Disable release notes generation | — |
|
|
68
67
|
| `-t, --template <path>` | Template file or directory | built-in |
|
|
69
68
|
| `-e, --engine <engine>` | Template engine: `handlebars`, `liquid`, `ejs` | `liquid` |
|
|
@@ -112,7 +111,6 @@ All options live under the `notes` key in `releasekit.config.json`:
|
|
|
112
111
|
}
|
|
113
112
|
},
|
|
114
113
|
"releaseNotes": {
|
|
115
|
-
"mode": "root",
|
|
116
114
|
"llm": {
|
|
117
115
|
"provider": "openai",
|
|
118
116
|
"model": "gpt-4o-mini",
|