ci: exclude release-please CHANGELOG.md from prettier check - #132
Merged
Conversation
release-please generates CHANGELOG.md with asterisk bullets and blank lines around lists, a Markdown style prettier rewrites. Since #69 enforced `prettier --check .` in the Lint job without excluding the file, every release PR fails lint on the regenerated CHANGELOG (e.g. #93 for 1.4.0). CHANGELOG.md is owned by release-please, so exclude it from prettier. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![dobby-coder[bot]](https://avatars.githubusercontent.com/in/3365457?s=60&v=4){kind=small}
Contributor
Author
There was a problem hiding this comment.
VERDICT: approve
Rules Dobby 2 — sign-off (cycle 1)
Rule compliance + review check on the .prettierignore fix. No findings.
- Conventional-commit PR title (
ci:) — valid. - Touches only
.prettierignore, not.github/workflows/— correctly stays within App permissions. - PR body prose and the inline comment are plain and honest; the comment documents a genuinely non-obvious ignore entry.
- No security advisory referenced — no embargo concern.
Review Dobby 2 empirically verified the fix (prettier --check skips the release-please CHANGELOG.md; npm run lint passes). Clean — flipping to ready.
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
1 participant
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.
What
Add
CHANGELOG.mdto.prettierignoreso the release-please changelog is no longer prettier-checked.Why
The Lint job (
prettier --check . && eslint .) is failing on the release PR #93 (chore(main): release 1.4.0). TheCHANGELOG.mdthat release-please regenerates uses asterisk (*) list bullets with blank lines around each list, and prettier rewrites those to hyphen bullets with no surrounding blank lines. Every release PR hits this.The check was introduced in #69, which reformatted the existing changelog to prettier's style but didn't exclude the file, so the conflict surfaces the next time release-please writes to it — now, for 1.4.0.
CHANGELOG.mdis generated and owned by release-please, so it should not be subject to the prettier check. Once this merges, release-please rebuilds #93's branch on top ofmainand its Lint job goes green.Verification
Dropped the failing release-please
CHANGELOG.mdin place and confirmedprettier --checkskips it, andnpm run lintpasses end to end.Unblocks #93.