chore(repo): Improve formatting of server entries in release notes

[ericallam]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 89b4d85

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4451fcb and 89b4d85.

📒 Files selected for processing (1)

• scripts/enhance-release-pr.mjs

📜 Recent review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (26)

• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
• GitHub Check: sdk-compat / Node.js 22.12 (ubuntu-latest)
• GitHub Check: sdk-compat / Cloudflare Workers
• GitHub Check: sdk-compat / Bun Runtime
• GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
• GitHub Check: sdk-compat / Node.js 20.20 (ubuntu-latest)
• GitHub Check: sdk-compat / Deno Runtime
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
• GitHub Check: typecheck / typecheck
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)

🔇 Additional comments (1)

scripts/enhance-release-pr.mjs (1)

305-309: LGTM!

The fix correctly handles multi-line Markdown list items by indenting continuation lines with 2 spaces, ensuring they remain within the same bullet point. This is the standard approach for Markdown list formatting.

---

Walkthrough

The change modifies scripts/enhance-release-pr.mjs to improve the rendering of multi-line server change entries in release pull requests. When rendering bullet list items with multi-line text, the script now indents continuation lines by replacing newlines with newline characters followed by two spaces. This formatting adjustment ensures that multi-line content remains properly structured within the same list item.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The pull request description is missing entirely. The template requires Testing, Changelog, and other sections that are not provided.	Add a complete pull request description following the template, including Testing section, Changelog entry, and the required checklist.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: improving formatting of server entries in release notes by indenting multiline entries.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ericallam-patch-1

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

Devin Review found 1 potential issue.

View 1 additional finding in Devin Review.

[devin-ai-integration]

🟡 Multi-line indentation fix not applied to server breaking changes in the 'Breaking changes' section

The PR adds newline indentation for server entries in the "Server changes" section (line 307), but serverBreaking entries are also rendered as list items in the "Breaking changes" section at line 264 without the same treatment.

Inconsistent handling of multi-line server entries

Server entries get their text from .server-changes/*.md file bodies (scripts/enhance-release-pr.mjs:185), which can contain newlines. The PR correctly indents continuation lines in the "Server changes" section:

const indented = entry.text.replace(/\n/g, "\n  ");
lines.push(`- ${indented}`);

However, at line 263-264, serverBreaking entries are rendered without this fix:

for (const entry of [...breaking, ...serverBreaking])
    lines.push(`- ${entry.text}`);

If a server breaking change has multi-line body text, the continuation lines will not be indented, breaking the markdown list formatting in the "Breaking changes" section. The text after the first newline would appear outside the list item.

Impact: Multi-line server breaking change entries will render with broken markdown formatting in the PR body.

(Refers to line 264)

---

Was this helpful? React with 👍 or 👎 to provide feedback.