fix(ci): write each paragraph of the nightly release notes on one line - #333
Merged
Merged
Conversation
Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
HuiJun
marked this pull request as ready for review
September 16, 2026 00:25
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
The nightly snapshot's release notes were written with the source wrapped at ~90 columns. GitHub renders a release body with hard line breaks, so the published notes broke mid-sentence after every source line. The "Write the release notes" step now emits each prose paragraph as a single line; the code block and the changelog summary are unchanged.
$count commit(s)becomes1 commit/N commits.How it was verified
Ran the step's script locally with the workflow's environment variables set and confirmed each paragraph is one line and the rest of the body is byte-identical in structure.
Checklist
make testandmake lintpass locally (workflow-only change;python3 scripts/changelog.py checkpasses)changes/unreleased/<slug>.<section>.md, not as an edit toCHANGELOG.mdmake docs-countsrun if a gate count moved (compliance rows need nothing: the census is counted at docs build)F4,K5) in the body, docs, or changelog