Skip to content

docs: update changelog for v2.13.1 - #5

Merged
shenxianpeng merged 3 commits into
mainfrom
chore/update-changelog-for-2-13-1
Aug 4, 2026
Merged

docs: update changelog for v2.13.1#5
shenxianpeng merged 3 commits into
mainfrom
chore/update-changelog-for-2-13-1

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Aug 4, 2026

Copy link
Copy Markdown
Member

What

Adds the v2.13.1 entry to the changelog:

  • New feature: --format json and validate_all_detailed() now report the checked value on passing checks (PR commit-check/commit-check#522)
  • Highlights table row for 2.13.1, linking to the "Output for scripts and CI" recipe

Add the v2.13.1 entry covering the checked-value reporting in JSON
output (#522) and the commit-check.com link in the config header
(#524), plus the Highlights row.
@netlify

netlify Bot commented Aug 4, 2026

Copy link
Copy Markdown

Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit bfee058
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6a727864fbeb63000878ce21
😎 Deploy Preview https://deploy-preview-5--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@shenxianpeng, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 56 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1a5b4f28-0a72-407c-b11f-c0ccc5258371

📥 Commits

Reviewing files that changed from the base of the PR and between 219eaa4 and bfee058.

📒 Files selected for processing (1)
  • docs/changelog.md
📝 Walkthrough

Walkthrough

The changelog adds a v2.13.1 highlight and release section. It documents validated values in passing JSON output and validate_all_detailed(), unchanged terminal output, and the commit-check.com link in generated cchk.toml files.

Changes

v2.13.1 release documentation

Layer / File(s) Summary
Document v2.13.1 changes
docs/changelog.md
The changelog documents populated values for passing checks, unchanged terminal output, and the new generated cchk.toml header link.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the v2.13.1 changelog update, which matches the pull request's main change.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-changelog-for-2-13-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/changelog.md`:
- Line 14: Update the changelog link in the 2.13.1 entry to reference the actual
heading fragment in docs/example.md, or add a stable explicit anchor there and
link to it. Preserve the existing destination section and link text.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 516fe3a4-3668-4c77-a8e2-b8cfa6d14245

📥 Commits

Reviewing files that changed from the base of the PR and between b6ea850 and 219eaa4.

📒 Files selected for processing (1)
  • docs/changelog.md

Comment thread docs/changelog.md

| Version | What changed | Documented in |
|---|---|---|
| [2.13.1](#v2131) | JSON output reports the checked value for passing checks | [Output for scripts and CI](example.md#output-for-scripts-and-ci) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Fix the broken recipe link.

markdownlint-cli2 reports that #output-for-scripts-and-ci is not a valid fragment in docs/example.md. Update the fragment to the actual heading anchor or add a stable explicit anchor.

🧰 Tools
🪛 markdownlint-cli2 (0.23.2)

[warning] 14-14: Link fragments should be valid

(MD051, link-fragments)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/changelog.md` at line 14, Update the changelog link in the 2.13.1 entry
to reference the actual heading fragment in docs/example.md, or add a stable
explicit anchor there and link to it. Preserve the existing destination section
and link text.

Source: Linters/SAST tools

A comment link in the generated cchk.toml template does not change
user-visible behavior and is below the changelog's bar for notable
changes.
@shenxianpeng
shenxianpeng merged commit ea60e6e into main Aug 4, 2026
7 checks passed
@shenxianpeng
shenxianpeng deleted the chore/update-changelog-for-2-13-1 branch August 4, 2026 23:40
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.

1 participant