also looking at this
fix(release): add non-mutating changelog previews
#306
5 files
+132
-0
| @@ -0,0 +1,23 @@ | ||
| 1 | # Preview release notes safely | |
| 2 | ||
| 3 | After `bun install`, preview changes since the latest reachable tag without | |
| 4 | writing release notes into the checkout: | |
| 5 | ||
| 6 | ```sh | |
| 7 | bun run changelog:preview | |
| 8 | bun run changelog:preview --from v0.0.92 --to HEAD | |
| 9 | ``` | |
| 10 | ||
| 11 | The preview resolves both refs to commits, directs the installed logsmith CLI | |
| 12 | to an isolated temporary file, prints its contents, and removes that temporary | |
| 13 | directory. Existing edits to `CHANGELOG.md` are preserved. Only `--from` and | |
| 14 | `--to` are accepted; output overrides are deliberately unavailable. | |
| 15 | ||
| 16 | Do not use logsmith 0.2.3's `--no-output` for a dry preview: its CLI currently | |
| 17 | writes `CHANGELOG.md` despite that flag. This command is a Craft workaround, | |
| 18 | not a fix to the upstream parser or its duplicate issue-reference rendering | |
| 19 | (tracked in [#283](https://github.com/craft-native/craft/issues/283)). Review | |
| 20 | generated issue links before releasing. | |
| 21 | ||
| 22 | `bun run changelog:generate` remains the intentional command for updating | |
| 23 | `CHANGELOG.md`. Neither command publishes packages or creates a release tag. | |