Skip to content

Commit 94cd2f4

Browse files
committed
Use CHANGELOG as the only release-notes source
Prep Unreleased for the next cut, teach release.sh to build the GitHub body from the matching version section plus install instructions, and drop the parallel docs/release-notes and scripts/notes copies.
1 parent e4621c1 commit 94cd2f4

11 files changed

Lines changed: 44 additions & 708 deletions

CHANGELOG.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22

33
All notable changes to Corbits Code are documented here.
44

5-
Format loosely follows [Keep a Changelog](https://keepachangelog.com/). Versions are `package.json` / `vX.Y.Z` git tags cut by `scripts/release.sh`.
5+
Format loosely follows [Keep a Changelog](https://keepachangelog.com/). Versions
6+
are `package.json` / `vX.Y.Z` git tags cut by `scripts/release.sh`.
7+
8+
**This file is the only release-notes source.** `/changelog` and the shipped
9+
binary read it; `scripts/release.sh` builds the GitHub release body from the
10+
matching `## [X.Y.Z]` section (plus install instructions). Do not maintain
11+
parallel copies under `docs/` or `scripts/notes/`. At cut time: rename
12+
`## [Unreleased]` to `## [X.Y.Z] - YYYY-MM-DD`, then run the release script.
613

714
## [Unreleased]
815

docs/release-notes-0.2.90.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/release-notes-0.2.91.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

docs/release-notes-0.2.92.md

Lines changed: 0 additions & 95 deletions
This file was deleted.

docs/release-notes-0.2.93.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)