Skip to content

chore(lint): leave CHANGELOG.md as release-please writes it, so release PRs pass the format check - #583

Merged
Vivswan merged 1 commit into
mainfrom
chore/biome-skip-changelog
Nov 11, 2026
Merged

Vivswan merged 1 commit into
mainfrom
chore/biome-skip-changelog

Conversation

@Vivswan

@Vivswan Vivswan commented Nov 11, 2026

Copy link
Copy Markdown
Owner

Before

release-please refreshes the release PR -> CHANGELOG.md gains an entry with `*` bullets -> biome ci formats markdown -> checks / check red
$ bun x biome ci --error-on-warnings .
CHANGELOG.md format
  x File content differs from formatting output
Found 1 error.
error: script "lint" exited with code 1

After

release-please refreshes the release PR -> CHANGELOG.md is not formatted -> checks / check green
$ bun x biome ci --error-on-warnings CHANGELOG.md      (the release PR's CHANGELOG.md)
Checked 1 file in 7ms. No fixes applied.

How

  • One override in biome.local.jsonc turns the formatter off for CHANGELOG.md, the file release-please owns.
  • The managed biome.json is untouched; the same exclusion belongs in the fleet layer eventually.

Proof

  • Control: the release PR's CHANGELOG.md fails biome ci without the override and passes with it.
  • Gate: bun run lint green, 1037 files.
Technical details
  • Release PR chore(main): release 3.0.0 #58 does not re-run on this merge. A chore commit refreshes no release notes, so close and reopen chore(main): release 3.0.0 #58 to re-run its checks against the new main.
  • Main's CHANGELOG.md keeps its formatted history. release-please only prepends, so older entries stay as they are.
  • Files: biome.local.jsonc.

…se PRs pass the format check

Biome 2.6 formats markdown, and release-please writes each new changelog entry with `*` bullets and its own blank lines, so the release PR failed the format check on every refresh. The formatter is off for that one file.
Copilot AI balanced review requested due to automatic review settings November 11, 2026 16:50
@github-actions

Copy link
Copy Markdown
Contributor

File size check

0 over a hard cap (fails), 6 warning(s).

File Size Tier Cap
src/engine/diff.ts:56 11 comment lines warn 10
src/github/api-error.ts:9 11 comment lines warn 10
src/problem.ts:73 18 comment lines warn 10
src/sections/contract/errors.ts:13 11 comment lines warn 10
src/sections/contract/module.ts:55 12 comment lines warn 10
src/sections/shared/list/decl.ts:265 14 comment lines warn 10

Split the file, wrap the line, shorten or exempt the comment, or list the path in .file-size-allow.local with a # reason.

5 managed file(s) skipped; repo-platform owns them.

@github-actions

Copy link
Copy Markdown
Contributor

Member shape check

1 finding(s).

File Line Rule
test/sections/contract/validate-hook.test.ts 80 all-or-none

Add the blank lines, make the comment one line directly above the item, comment every field or none, or list the path in .member-shape-allow.local with a # reason.

4 generated file(s) skipped.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues block the formatter-only exception that preserves the release-please-generated changelog.

No open issues 🎉

What changed in this PR

Prevents release PR format failures by preserving CHANGELOG.md as release-please generates it.

Changes:

  • Disables formatting for CHANGELOG.md through a local Biome override.
  • Documents the exception while leaving the managed biome.json unchanged.
File Description
biome.local.jsonc Adds a formatter-only exception for the release-please changelog.

Review effort: Balanced

@Vivswan
Vivswan marked this pull request as ready for review November 11, 2026 17:41
@Vivswan
Vivswan merged commit 56d949a into main Nov 11, 2026
28 checks passed
@Vivswan
Vivswan deleted the chore/biome-skip-changelog branch November 11, 2026 17:42
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.

2 participants