Skip to content

Commit feb65ad

Browse files
committed
docs(release): trim the war stories out of the doc comments
Review: the v1.1.161 story belongs in the PR, not in three doc comments. Apply @BarrensZeppelin's suggestions verbatim.
1 parent 15fd47a commit feb65ad

2 files changed

Lines changed: 3 additions & 13 deletions

File tree

‎scripts/release/add-unreleased.mts‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,12 @@
55
* the way a human does. The counterpart to `bump.mts`, which promotes the
66
* block at release time.
77
*
8-
* This exists so a caller never has to reimplement the shape. Both things it
9-
* deliberately cannot touch — `package.json`'s `version` and the
10-
* `## [X.Y.Z]` headings — belong to the release workflow, and a caller that
11-
* wrote them has already cost a release its notes: v1.1.161 shipped with
12-
* commit-derived notes because a hand-written heading had consumed the block
13-
* the release meant to promote.
8+
* This exists so a caller never has to reimplement the shape.
149
*
1510
* Usage:
1611
* node scripts/release/add-unreleased.mts [flags] <entry>
1712
*
18-
* Example — the Coana bump, which reruns on every Coana release and so must
19-
* update its own line rather than stack a new one each time:
13+
* Example — the Coana bump, which reruns on every Coana release:
2014
* node scripts/release/add-unreleased.mts \
2115
* --replace '^Updated the Coana CLI to v ' \
2216
* 'Updated the Coana CLI to v `15.10.28`.'

‎scripts/release/changelog.mts‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -349,11 +349,7 @@ export interface AddUnreleasedEntryConfig {
349349
*
350350
* NOTHING ELSE MOVES. The release owns `package.json`'s version and every
351351
* `## [X.Y.Z]` heading — it derives the version from the tags and promotes this
352-
* block under a heading it writes itself. A caller that writes either invents a
353-
* version that may never ship and consumes the block the release meant to
354-
* promote, which has already cost a release its notes. So an accruing note goes
355-
* here and only here, whether a human, the `/bump-coana` skill, or another
356-
* repo's automation is writing it.
352+
* block under a heading it writes itself.
357353
*
358354
* The block is created when the previous release consumed it, and a decorated
359355
* heading is repaired, so there is always somewhere for the entry to go that

0 commit comments

Comments
 (0)