@releasekit/notes 0.42.1 → 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 +3 -41
- package/dist/{aggregator-DYYIWNIK.js → aggregator-SCGIHWXW.js} +2 -2
- package/dist/{chunk-KQQPQQSS.js → chunk-6HUNK367.js} +1 -1
- package/dist/{chunk-OTH3XXI4.js → chunk-T54LUVMQ.js} +202 -99
- package/dist/{chunk-CBMVDKDR.js → chunk-YIHEHXCU.js} +72 -31
- package/dist/cli.js +2 -2
- package/dist/index.d.ts +8 -2
- package/dist/index.js +5 -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
|
@@ -34,7 +34,7 @@ npm install -g @releasekit/notes
|
|
|
34
34
|
pnpm add -g @releasekit/notes
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
> **Note:** ESM only. Requires Node.js
|
|
37
|
+
> **Note:** ESM only. Requires Node.js 22.12+.
|
|
38
38
|
|
|
39
39
|
## Quick Start
|
|
40
40
|
|
|
@@ -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**
|