chore: reformat CHANGELOG.md to match prettier config - #216
Conversation
Same recurring issue as PR #213 (after 3.3.24) and PR #212's failure: semantic-release's changelog output for 3.3.25 doesn't match this repo's prettier config, which release.yml's format-check step validates fresh on every subsequent push. This blocked PR #215's merge-triggered release run at the Semantic Release job's Format Check step, so no release could be cut and v3.3.25's still-missing Docker image couldn't be retried.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR runs Prettier against CHANGELOG.md so the auto-generated 3.3.25 entry and surrounding text conform to the repository’s formatting rules, unblocking the release pipeline’s format check. Flow diagram for release pipeline unblocking via Prettier formattingflowchart LR
dev[Developer runs prettier --write CHANGELOG.md]
file[CHANGELOG_md formatted]
check[npx prettier --check CHANGELOG_md]
format_check[release_yml Semantic_Release format_check]
release[Semantic_Release job proceeds]
dev --> file --> check --> format_check --> release
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
🟡 Not ready to approve
CHANGELOG.md currently contains a duplicated “# Changelog” header/intro block in the edited region, which should be removed to keep the document structure correct.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR reformats the auto-generated CHANGELOG.md entry for v3.3.25 to align with the repository’s Prettier Markdown formatting, unblocking the release workflow’s format-check gate.
Changes:
- Wraps the introductory “Keep a Changelog / Semantic Versioning” prose to match Prettier’s line-wrapping.
- Normalizes changelog list formatting (e.g.,
-bullets and wrapped link lines) for the v3.3.25 section.
File summaries
| File | Description |
|---|---|
| CHANGELOG.md | Reformats the v3.3.25 entry and surrounding prose to match Prettier’s Markdown output. |
Review details
Suppressed comments (1)
CHANGELOG.md:26
- There is a duplicated “# Changelog” header and intro block immediately after the 3.3.25 entry (the file already starts with the same header + intro). This makes the changelog structure confusing and leads to repeated top-level headings in rendered Markdown. Remove the second header/intro block so the 3.3.25 entry flows into the rest of the changelog without reintroducing the document prologue.
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
Summary
## [3.3.25]changelog entry doesn't match this repo's prettier config.release.yml's Semantic Release job at the Format Check step on every push tomain— it just failed PR fix(ci): pin QEMU setup in release.yml to stop arm64 npm ci crash #215's merge-triggered release run for exactly this reason, which means no new release can be cut right now, including a retry at publishing v3.3.25's still-missing Docker image (see PR fix(ci): pin QEMU setup in release.yml to stop arm64 npm ci crash #215).prettier --write CHANGELOG.md, no content changes.Test plan
npx prettier --check CHANGELOG.mdpasses🤖 Generated with Claude Code
Summary by Sourcery
Chores: