fix: format CHANGELOG.md after changeset version - #153
Conversation
Changesets writes CHANGELOG.md without project formatting rules, causing the version packages PR to fail CI until ultracite fix is run manually. Co-authored-by: Cursor <cursoragent@cursor.com>
|
📝 WalkthroughWalkthroughThe ChangesRelease Versioning and Formatting Fix
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
commit: |
Changesets assembles nested markdown into CHANGELOG.md that triggers oxfmt rules not applied to source .changeset/*.md files, causing PR #103 to fail the check job until ultracite fix was run manually. Co-authored-by: Cursor <cursoragent@cursor.com>
commit: |
Changesets embeds changeset bodies as indented list continuations; oxfmt rejects the resulting blank lines after nested headings (PR #103). Run oxfmt on CHANGELOG.md only after version — not a full ultracite fix and not excluding the file from checks. Co-authored-by: Cursor <cursoragent@cursor.com>
commit: |
Summary
PR #103 failed only
ultracite checkonCHANGELOG.md.Why:
@changesets/changelog-githubindents multi-line changeset bodies under list items. Blank lines in.changeset/*.mdbecome whitespace-only indented lines; oxfmt rejects those after nested###headings. The same prose in a standalone changeset file passes — the failure is specific to assembled changelog structure.Fix:
version-packagesrunschangeset version && oxfmt CHANGELOG.md. This formats only the generated changelog (notbun run fixacross the repo) and keepsCHANGELOG.mdin the ultracite check scope.release.ymlalready callsbun run version-packages.Test plan
bun run typecheckbun run checkCHANGELOG.mdcontent passesultracite checkafteroxfmt CHANGELOG.mdcheckwithout manual editsNote
Format CHANGELOG.md automatically after running changeset version
Adds
oxfmt CHANGELOG.mdto theversion-packagesscript in package.json so the changelog is formatted afterchangeset versionruns. Updates release.yml to invokebun run version-packagesinstead ofbun changeset versiondirectly, so the formatting step is included in the release PR workflow.Macroscope summarized 2a09ed7.