Skip to content

fix: format CHANGELOG.md after changeset version - #153

Merged
mynameistito merged 3 commits into
mainfrom
fix/release-ultracite-after-version
Jun 24, 2026
Merged

fix: format CHANGELOG.md after changeset version#153
mynameistito merged 3 commits into
mainfrom
fix/release-ultracite-after-version

Conversation

@mynameistito

@mynameistito mynameistito commented Jun 24, 2026

Copy link
Copy Markdown
Owner

Summary

PR #103 failed only ultracite check on CHANGELOG.md.

Why: @changesets/changelog-github indents multi-line changeset bodies under list items. Blank lines in .changeset/*.md become 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-packages runs changeset version && oxfmt CHANGELOG.md. This formats only the generated changelog (not bun run fix across the repo) and keeps CHANGELOG.md in the ultracite check scope.

release.yml already calls bun run version-packages.

Test plan

  • bun run typecheck
  • bun run check
  • PR chore: version packages #103 CHANGELOG.md content passes ultracite check after oxfmt CHANGELOG.md
  • Merge and confirm version packages PR passes check without manual edits

Note

Format CHANGELOG.md automatically after running changeset version

Adds oxfmt CHANGELOG.md to the version-packages script in package.json so the changelog is formatted after changeset version runs. Updates release.yml to invoke bun run version-packages instead of bun changeset version directly, so the formatting step is included in the release PR workflow.

Macroscope summarized 2a09ed7.

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>
@changeset-bot

changeset-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2a09ed7

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

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The version-packages script in package.json is updated to run bun run fix after changeset version. CHANGELOG.md is added to the formatter's ignorePatterns in oxfmt.config.ts. The release workflow is updated to call bun run version-packages instead of bun changeset version directly.

Changes

Release Versioning and Formatting Fix

Layer / File(s) Summary
version-packages script and formatter ignore rule
package.json, oxfmt.config.ts
version-packages script updated to run changeset version && bun run fix; oxfmt.config.ts extends ignorePatterns to exclude CHANGELOG.md and adds comments about config assembly.
Release workflow command update
.github/workflows/release.yml
"Create release pull request" step changed from bun changeset version to bun run version-packages to delegate to the updated script.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐇 Hop, hop, the changelog ignores my gaze,
bun run fix tidies up after versioning days.
No more stray formats sneaking into the diff,
The workflow now calls one script — quite a gift!
Everything's neat, a formatter's delight. 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main change: formatting CHANGELOG.md after changeset versioning.
Description check ✅ Passed The description matches the changeset by explaining the changelog formatting fix and the updated release workflow command.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/release-ultracite-after-version

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

Comment @coderabbitai help to get the list of available commands.

@pkg-pr-new

pkg-pr-new Bot commented Jun 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

bun add https://pkg.pr.new/create-cf-token@84c5790

commit: 84c5790

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>
@mynameistito mynameistito changed the title fix: run ultracite fix after changeset version in release workflow fix: exclude CHANGELOG.md from oxfmt to fix version packages CI Jun 24, 2026
@pkg-pr-new

pkg-pr-new Bot commented Jun 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

bun add https://pkg.pr.new/create-cf-token@4d43027

commit: 4d43027

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>
@mynameistito mynameistito changed the title fix: exclude CHANGELOG.md from oxfmt to fix version packages CI fix: format CHANGELOG.md after changeset version Jun 24, 2026
@pkg-pr-new

pkg-pr-new Bot commented Jun 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

bun add https://pkg.pr.new/create-cf-token@2a09ed7

commit: 2a09ed7

@mynameistito
mynameistito merged commit b8d1330 into main Jun 24, 2026
28 checks passed
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