Skip to content

fix(ci): write each paragraph of the nightly release notes on one line - #333

Merged
HuiJun merged 1 commit into
developfrom
fix/nightly-notes-line-breaks
Sep 16, 2026
Merged

HuiJun merged 1 commit into
developfrom
fix/nightly-notes-line-breaks

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

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) becomes 1 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 test and make lint pass locally (workflow-only change; python3 scripts/changelog.py check passes)
  • Tests added or updated for the change (none cover the workflow)
  • Documentation extended where it already covers the surface (see CONTRIBUTING.md)
  • Changelog entry added as changes/unreleased/<slug>.<section>.md, not as an edit to CHANGELOG.md
  • baselines regenerated and make docs-counts run if a gate count moved (compliance rows need nothing: the census is counted at docs build)
  • No internal work-item labels (waves, slices, F4, K5) in the body, docs, or changelog

Co-Authored-By: jason.han <hanhuijun@gmail.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@HuiJun
HuiJun marked this pull request as ready for review September 16, 2026 00:25

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@HuiJun
HuiJun merged commit 1ce0e9d into develop Sep 16, 2026
12 checks passed
@HuiJun
HuiJun deleted the fix/nightly-notes-line-breaks branch September 16, 2026 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant