Skip to content

docs: pin v2.20.5 and add its changelog entry - #84

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp
Nov 11, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Before: the site describes 2.20.4. The six pre-commit snippets pin rev: v2.20.4, the changelog stops at v2.20.4, and two pages describe behaviour 2.20.5 changed:

  • "Checking the committer" does not say the author checks were skipped on a repository's first commit.
  • CC017 says the advice names user.* and GIT_AUTHOR_*, and adds author.name / author.email as a separate hint.

After: the site describes 2.20.5, published 2026-11-11.

  • All six snippets pin rev: v2.20.5.
  • The changelog has a v2.20.5 entry (four lines) and a Highlights row.
  • "Checking the committer" says the identity is checked on a first commit from 2.20.5 on.
  • CC017 lists the four settings the advice itself now names.

What the released 2.20.5 prints in the two cases:

$ git init -q . && git config user.name claude   # no commit yet, author_name_pattern set
$ commit-check --author-name
✖ Commit rejected by Commit Check · 1 check failed

✖ CC101 author-name failed: claude
  The committer name seems invalid
  Suggest: git config user.name 'Your Name'
  Docs:    https://commit-check.com/rules/#cc101
$ echo "feat: add streaming support" | commit-check -m   # author.name is Claude, ai_attribution = "forbid"
✖ Commit rejected by Commit Check · 1 check failed

✖ CC017 ai-author failed: Claude <noreply@anthropic.com>
  An AI tool is the commit author: Claude Code
  Suggest: Commit as yourself: set git config user.name and user.email to your own, and unset author.name, author.email, GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL if a tool set them; a commit that already exists then needs git commit --amend --reset-author
  Docs:    https://commit-check.com/rules/#cc017

2.20.4 printed ⊘ skipped (not validated): author-name for the first.

How

  • "About half the time to start" in the changelog is measured on the two released wheels with commit-check -m <file>: 480M instructions on 2.20.4 against 244M on 2.20.5 (callgrind), 119 ms against 68 ms wall time (median of 25 runs).
  • tests/docs_sync_test.py passes against the installed 2.20.5 (18 tests) and mkdocs build --strict is clean.
  • Blog posts and the two homepage transcripts recorded with 2.20.4 are left as they are.

Summary by CodeRabbit

  • Documentation
    • Added v2.20.5 release highlights covering first-use compilation of AI signature patterns, PyPI provenance attestations, author checks on a repository’s first commit, and updated CC017 guidance.
    • Clarified which author identity settings can override user.name and user.email, and when to unset them.
    • Updated pre-commit configuration examples to use v2.20.5.

The install snippets name v2.20.5, the changelog gains its entry and a
Highlights row, and two pages follow what the release changed: the
author checks cover a repository's first commit, and CC017's advice for
a message not yet committed lists author.name and author.email itself.
@netlify

netlify Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 99c9ca9
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6af40594bdd47305eba6f9ee
😎 Deploy Preview https://deploy-preview-84--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 Nov 11, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation adds the v2.20.5 release notes, updates guidance about first-commit identity checks and CC017, and changes pre-commit examples to pin v2.20.5.

Changes: v2.20.5 documentation

Layer / File(s) Summary
Release notes
docs/changelog.md
The changelog adds v2.20.5 highlights and a release entry covering AI signature pattern compilation, PyPI provenance attestations, first-commit identity checks, and CC017 guidance.
Identity-check guidance
docs/example.md, docs/rules.md
The committer documentation describes identity checks on a repository’s first commit. CC017 guidance lists author.name, author.email, GIT_AUTHOR_NAME, and GIT_AUTHOR_EMAIL as values to unset, and says they take precedence over user.name and user.email.
Pre-commit revision pins
docs/compare/tools.md, docs/configuration.md, docs/example.md, docs/guides/pre-commit.md
The pre-commit examples change their pinned revision from v2.20.4 to v2.20.5.

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

Change: Other

Possibly related PRs

Merge Risk: Minimal · up to 99c9c

The documentation updates present no identified merge-blocking risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title clearly and concisely describes the main changes: updating documentation to pin v2.20.5 and adding its changelog entry.
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.
Finishing Touches

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

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: 06617b1b-20de-4827-a036-526e8cbc71fe
Commits

Reviewing files that changed from the base of the PR and between 8337fe5 and 99c9ca9.

Files selected for processing: 6

  • docs/changelog.md
  • docs/compare/tools.md
  • docs/configuration.md
  • docs/example.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.

@shenxianpeng
shenxianpeng merged commit ced8ec6 into main Nov 11, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-pofwgp branch November 11, 2026 06:20
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