Repository navigation
chore(lint): leave CHANGELOG.md as release-please writes it, so release PRs pass the format check - #583
Merged
Conversation
…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.
Contributor
File size check0 over a hard cap (fails), 6 warning(s).
Split the file, wrap the line, shorten or exempt the comment, or list the path in 5 managed file(s) skipped; repo-platform owns them. |
Contributor
Member shape check1 finding(s).
Add the blank lines, make the comment one line directly above the item, comment every field or none, or list the path in 4 generated file(s) skipped. |
There was a problem hiding this comment.
🟢 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.mdthrough a local Biome override. - Documents the exception while leaving the managed
biome.jsonunchanged.
| File | Description |
|---|---|
biome.local.jsonc |
Adds a formatter-only exception for the release-please changelog. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before
After
How
biome.local.jsoncturns the formatter off forCHANGELOG.md, the file release-please owns.biome.jsonis untouched; the same exclusion belongs in the fleet layer eventually.Proof
CHANGELOG.mdfailsbiome ciwithout the override and passes with it.bun run lintgreen, 1037 files.Technical details
chorecommit refreshes no release notes, so close and reopen chore(main): release 3.0.0 #58 to re-run its checks against the new main.CHANGELOG.mdkeeps its formatted history. release-please only prepends, so older entries stay as they are.biome.local.jsonc.