Skip to content

GitHub release descriptions break every wrapped line #390

Closed

Description

@homer6

GitHub renders every newline in a release description as a hard line break. docs/releases/vX.Y.Z.md is wrapped at about 78 columns, so each GitHub release we've published shows its sentences broken mid-line (rendered <br> counts: v0.5.0 about 90 before it was fixed, v0.4.0 71, v0.3.0 75, v0.2.1 20, v0.2.0 41, v0.1.0 39).

The release step only rewrote relative links to blob/vX.Y.Z/; nothing unwrapped the lines.

Plan:

  • tools/release_notes.py vX.Y.Z: prints the GitHub release text from docs/releases/vX.Y.Z.md, with relative links made absolute at the tag and hard-wrapped paragraphs and list items joined (headings, tables, code, comments untouched); --self-test runs built-in samples.
  • The release checklist in CLAUDE.md names it for gh release create / gh release edit.
  • Rewrite the descriptions of v0.1.0–v0.4.0 the same way (v0.5.0 already done on 2026-11-04).

Activity

  1. self-assigned this
    on Nov 4, 2026
  2. homer6 commented on Nov 4, 2026

    @homer6
    OwnerAuthor

    Delivered in #391.

    What changed

    • tools/release_notes.py vX.Y.Z prints the GitHub release text: wrapped paragraph, list and quote lines joined; headings, tables, code and comments untouched; relative links absolute at the tag; --self-test (11 samples).
    • CLAUDE.md release checklist step 5 publishes (and edits) the release from it; docs/releases/README.md points to it.
    • Done directly on GitHub: the descriptions of v0.1.0–v0.5.0 rewritten the same way. Rendered <br> count 0 on each, words unchanged.

    Why

    • GitHub renders each newline in a release description as a line break, so the 78-column notes broke mid-sentence on every release page. Checked through the API's rendered HTML (application/vnd.github.html+json) before and after.

    Still open

    • Nothing.
  3. homer6 commented on Nov 4, 2026

    @homer6
    OwnerAuthor

    Merged in #391 (7d9c49a).

    What changed

    • Nothing since the PR opened.

    Why

    • As in the closing comment; the script reproduces the published v0.5.0 text exactly.

    Still open

    • It goes into a v0.5.0 re-release, at the owner's request.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions