wu-sheng opened a new pull request, #50:
URL: https://github.com/apache/skywalking-horizon-ui/pull/50
## Why
The GitHub Releases page rendered our release notes with a ragged right edge
and a lot of empty space (see v0.6.0). Root cause: a Release body is rendered
with **GFM hard line breaks ON**, so every single newline becomes a literal
`<br>`. `CHANGELOG.md` is hard-wrapped at ~80 cols, so each wrap became a
forced break. The repo file view collapses those same newlines to spaces
(CommonMark soft breaks), which is why the breakage was invisible until you
looked at the release page.
Confirmed against GitHub Docs ("Basic writing and formatting syntax →
Paragraphs") and GitHub's live `/markdown` API.
## What
- **`CHANGELOG.md`** — normalized to **one line per paragraph / list item**
(no hard wrap). Renders identically in the file view, flows correctly in
release bodies. Verified byte-identical content under whitespace-collapse;
rendered `h2`/`h3`/`ul`/`li` structure unchanged; `<br>` 860 → 0. Also
straightens two bullets (0.4.0, 0.6.0) that wrapped onto a line starting with a
list marker, which CommonMark mis-parsed as a spurious nested bullet — broken
in *both* the file view and the release body, now single clean lines.
- **`scripts/changelog-release-notes.mjs`** (new) — extracts a version's
section and unwraps it for the release body. `--whole-file` normalizes an
entire file to the one-line style (used to convert the CHANGELOG; re-runnable).
- **`scripts/release-finalize.sh`** — release notes now go through the
helper instead of raw `awk` extraction, so a future hand-wrapped entry is still
unwrapped at publish time.
- **`CLAUDE.md`** — documents the one-line house style for `CHANGELOG.md`
and `docs/`.
## Live release pages
The published **0.4.0 / 0.5.0 / 0.6.0** release bodies were already
regenerated from this CHANGELOG and updated via `gh release edit` (rendered
`<br>` = 0 on all three; each release's signature / checksum / container-image
footer preserved).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
