[shenxianpeng]

Before: the docs-sync test was red on main (rev: v2.19.1 in five places, but 2.19.2 is on PyPI). Pasted outputs and examples had drifted from what the tool prints, and some guide pages described older Action and App behaviour.

After: the pins read v2.19.2, the test passes, and every change below was checked against commit-check 2.19.2, Action v2.18.0 or the App's main branch.

Page	Before	After
configuration, example, guides/pre-commit	rev: v2.19.1	rev: v2.19.2
rules, example	[FAIL] CC003 subject_imperative: …	[FAIL] CC003 subject-imperative: … (what --compact prints)
rules CC003 sample	shortened error and suggestion	the full lines the tool prints
rules CC012	"Signed-off-by not found in latest commit"	catalog text "Signed-off-by trailer not found in the latest commit"
rules CC016 sample	Suggest: Remove the AI sign-off …	Suggest: Use "Assisted-by: Claude" in place of the AI sign-off …
rules CC101	ec2-user as the failing example; "digits are rejected"	12 (it fails; ec2-user passes); a correct description of the pattern
rules CC005	fix: bug as the failing example (it passes at 5)	fix
getting-started step 3	git commit --amend -m … (git refuses on the empty commit from step 2)	git commit --amend --allow-empty -m …
getting-started CC201	Suggest: … with allowed types	the real suggestion, mentioning allow_branch_names
example	CC001 line cut short; develop missing from always-allowed names; bare -m called the commit-msg hook's form	full line; develop listed; the hook note moved to "From a file"
index	"Real output of commit-check 2.18.0", shortened CC001 line	2.19.2, full line
troubleshoot	12 called a "one-character name" and the recorded author; hook list without check-tag/check-files; --tag defaults missing	starts with a digit; the configured user.name; all seven hooks; SemVer default named
configuration	"Inheritance fails quietly"; Python API "loads the file"; unquoted TOML regexes; --tag missing from the defaults table	fails open with a stderr notice, one level only; the API takes a dict; quoted values; --tag row added
migration	"a trailing comma in an array" breaks TOML	removed (TOML allows it)
guides/github-actions	fetch-depth: 0 "or it only sees the most recent one"; forks "fail to post"; GITHUB_TOKEN passed by hand; no inputs list	shallow clones fall back to the API; fork comments are skipped with a warning; token not needed; inputs table, pr-title tip and result output
guides/github-app	2 of 4 checks failed titles; "every commit"; "fetches nothing else"	Commit message and branch failed (2 of 4 checks); newest 50 per push; the metadata it reads
guides/organization	"silently falls back"; "last line"	stderr notice; "last lines"
guides/policies	CC101/CC102 check the committer	the author
compare/tools	PR title checking not credited	the Action's pr-title

tests/docs_sync_test.py: the --compact guard compared samples with the config key, which --compact stopped printing. It now compares them with the kebab-case name.

How: pytest tests passes (10/10). The v2.19.2 items that another change covers are left out here: CC013 and the Copilot coding agent, the wrong-type config errors, the changelog, and the kernel cell in the AI-attribution article.

Summary by CodeRabbit

• Documentation
  • Clarified how commit checks handle pull request titles, squash messages, commit history, configuration inheritance, and fork workflows.
  • Updated examples and guidance for validation rules, branch names, author identity, tags, and pre-commit setup.
  • Added details about check results, permissions, and data accessed by the GitHub integrations.
• Tests
  • Updated documentation checks to match kebab-case rule names in default and compact output.

[netlify]

✅ Deploy Preview for commit-check ready!

Name	Link
🔨 Latest commit	575711e
🔍 Latest deploy log	https://app.netlify.com/projects/commit-check/deploys/6ad53fb6c46d918def437772
😎 Deploy Preview	https://deploy-preview-57--commit-check.netlify.app
📱 Preview on mobile	Toggle 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]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 0795cd8b-40c2-404a-9a80-2e11ca567480

📥 Commits

Reviewing files that changed from the base of the PR and between 39e60ab and 575711e.

📒 Files selected for processing: 14

• docs/compare/tools.md
• docs/configuration.md
• docs/example.md
• docs/getting-started.md
• docs/guides/github-actions.md
• docs/guides/github-app.md
• docs/guides/organization.md
• docs/guides/policies.md
• docs/guides/pre-commit.md
• docs/index.md
• docs/migration.md
• docs/rules.md
• docs/troubleshoot.md
• tests/docs_sync_test.py

+-----------------------------------------------------------------------------+
| If you can't handle me at my v0.0.1, then you don't deserve me at my v1.0.0 |
+-----------------------------------------------------------------------------+
  \
   \     /)/)
        ( '')
        /  |
      o(___)

✨ Finishing Touches

📝 Generate docstrings

• 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

• X
• Mastodon
• Reddit
• LinkedIn

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