027 — Release summary bullet sits flush and sentence fragments join without a semicolon (#165)
Status: in progress
Why
The summary bullet tp release writes under a new CHANGELOG heading is
written as - text, indented by one space, while the ### Added and
other bullets below it sit flush. The rendered Markdown is uneven and a
line-by-line reader matching ^- misses the summary.
A batch release builds its comment from each fragment's first line,
joined with ; . Fragment lines are sentences ending in a full stop, so
two of them give … instead of hanging.; Resolve vulnerabilities …. The
same string is the release pull request's title and the summary bullet,
so the .; shows in three places. Seen in lighthouse v0.11.1 and v0.11.2
(task-plus v0.41.0).
What changes
tp releasewrites the summary bullet flush (- text), in an existing CHANGELOG and in one it creates.- The batch release comment joins fragment first lines with a space when
the previous line ends in
.,!or?, and with;otherwise.
Acceptance
| Fragment first lines | Comment |
|---|---|
Do A. and Do B. |
Do A. Do B. |
Do A and Do B |
Do A; Do B |
Do A! and Do B and Do C |
Do A! Do B; Do C |
| CHANGELOG before | Comment | Summary line written |
|---|---|---|
has [Unreleased] |
Do A. |
- Do A. |
| no file | Do A. |
- Do A. |
[Unreleased] opens with - old |
Do A. |
- Do A. (replaces the slot, #30) |
Out of scope
- One summary bullet per fragment: the comment is also the pull request title, and the summary slot holds one bullet (#30).
- Rewriting
-bullets already in a CHANGELOG;CommentandopeningBulletkeep reading both forms.
Decisions
none
Done when
- tests express the acceptance table and pass
- spec updated (release-workflow.md)
- ADR written if a fork was resolved (none needed)
- roadmap ticked and stamped; changelog entry
- issue closed with a link to the release