Skip to content

chore: reformat CHANGELOG.md to match prettier config - #216

Open
docdyhr wants to merge 1 commit into
mainfrom
fix/changelog-prettier-format
Open

chore: reformat CHANGELOG.md to match prettier config#216
docdyhr wants to merge 1 commit into
mainfrom
fix/changelog-prettier-format

Conversation

@docdyhr

@docdyhr docdyhr commented Jul 31, 2026

Copy link
Copy Markdown
Owner

Summary

Test plan

  • npx prettier --check CHANGELOG.md passes
  • Pre-commit hooks (lint, typecheck, 384 security tests) passed
  • Pre-push hooks (build, 2416-test suite across 4 batches, 384 security tests, production dependency audit gate) all passed

🤖 Generated with Claude Code

Summary by Sourcery

Chores:

  • Adjust CHANGELOG.md markdown formatting without altering content to resolve Prettier-based format check failures in the release workflow.

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.
Copilot AI review requested due to automatic review settings July 31, 2026 10:12
@sourcery-ai

sourcery-ai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This 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 formatting

flowchart 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
Loading

File-Level Changes

Change Details Files
Reformat CHANGELOG.md with Prettier to match the project’s markdown style and fix wrapping/line breaks in the 3.3.25 section.
  • Join the Keep a Changelog and Semantic Versioning sentences onto a single line, then wrap the semantic versioning link to a new line according to Prettier rules.
  • Reflow the 3.3.25 bug-fix bullet so the CVE description remains on the first line and the issue/commit links are wrapped to subsequent indented lines.
  • Reflow the 3.3.25 documentation bullet so the main description stays on the first line and the issue/commit links and closing issue reference are wrapped to subsequent indented lines.
CHANGELOG.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot 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.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

🟡 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.

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