Skip to content

docs: pin v2.19.4 and add its changelog entry - #66

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/pin-v2.19.4
Oct 29, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
chore/pin-v2.19.4

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

Brings the site in step with v2.19.4, published 2026-10-29 (release, on PyPI).

Before / After

python -m pytest tests/ -q with commit-check==2.19.4 installed:

Result
Before (main) ❌ 2 failed, 16 passed: test_pinned_revisions_match_the_released_version, test_documented_defaults_match_the_runtime
After (this branch) ✅ 18 passed

What a reader sees:

Page Before After
pre-commit snippets (configuration, example, pre-commit guide ×3) rev: v2.19.3 rev: v2.19.4
Configuration → allow_branch_types default … "copilot", "cursor", "dependabot", "renovate" … "copilot", "cursor", "agents", "dependabot", "renovate", and the description names agents (the prefix VS Code's Agents window uses)
Rules → CC201 options default list without agents names agents among the defaults
Rules → CC013, Policy guides trailers listed up to Copilot's Agent-Logs-Url: also Cursor's Made-with: Cursor
Changelog latest entry v2.19.3 v2.19.4 (2026-10-29) entry and a Highlights row

Changes

  • Pins: docs/configuration.md, docs/example.md, docs/guides/pre-commit.md (blog posts untouched, as AGENTS.md asks).
  • agents in the default branch types, from feat(branch): accept the agents/ prefix by default commit-check#645: docs/configuration.md (Every option) and docs/rules.md (CC201). The spec-strict config on CC201 is unchanged: the Conventional Branch spec does not list agents yet.
  • Cursor's Made-with: Cursor trailer, from fix(ai): detect Cursor's Made-with trailer commit-check#643, which noted the site could name it once released: docs/rules.md (CC013) and docs/guides/policies.md.
  • docs/changelog.md: v2.19.4 entry with its release date, and a Highlights row, since the release changes what passes.

mkdocs build --strict passes locally (no warnings).

Summary by CodeRabbit

  • Documentation
    • Updated the changelog and policy guidance to describe recognition of Cursor’s Made-with: trailer. It is rejected when the forbid policy is enabled and corrected to Assisted-by: Cursor under disclose; other Made-with: values are unaffected.
    • Updated configuration and rule documentation to show agents as an accepted default branch prefix.
    • Updated pre-commit examples to use Commit Check v2.19.4.

@netlify

netlify Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 7095995
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6ae38bf7f995643e628e8e60
😎 Deploy Preview https://deploy-preview-66--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 Oct 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 8e26ee43-9628-4fec-87bd-c91f4c594f37
Commits

Reviewing files that changed from the base of the PR and between e421eae and 7095995.

Files selected for processing: 6
  • docs/changelog.md
  • docs/configuration.md
  • docs/example.md
  • docs/guides/policies.md
  • docs/guides/pre-commit.md
  • docs/rules.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The documentation adds the 2.19.4 release notes, describes the agents branch prefix and Cursor trailer handling, and updates pre-commit examples to use v2.19.4.

Changes: 2.19.4 Documentation

Layer / File(s) Summary
Document branch and Cursor trailer changes
docs/changelog.md, docs/configuration.md, docs/guides/policies.md, docs/rules.md
The documentation describes agents as an accepted default branch prefix and documents recognition of Made-with: Cursor, including the stated forbid and disclose handling.
Update pre-commit revision examples
docs/configuration.md, docs/example.md, docs/guides/pre-commit.md
Pre-commit examples now specify Commit Check revision v2.19.4 instead of v2.19.3.

Priority: Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: Minimal · up to 70959

The documented branch default matches v2.19.4. No actionable merge-blocking issue remains in these documentation updates.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the primary changes: updating documentation to version v2.19.4 and adding the corresponding changelog entry.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (6 skipped: 6 unsupported.)

Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@shenxianpeng
shenxianpeng merged commit e08a5c8 into main Oct 29, 2026
13 of 14 checks passed
@shenxianpeng
shenxianpeng deleted the chore/pin-v2.19.4 branch October 29, 2026 18:21
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