← 输入框|github.com|刷新
Skip to content

docs: pin v2.21.1 and document the CC004 squash suffix and bot skip - #87

Merged
shenxianpeng merged 1 commit into
mainfrom
docs/pin-v2.21.1
Nov 18, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
docs/pin-v2.21.1

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

Before: the site describes 2.21.0. The six pre-commit snippets pin rev: v2.21.0, the changelog stops at v2.21.0, and CC004 / CC005 count every character of the subject, for every author.

After: the site describes 2.21.1, published 2026-11-18.

  • All six snippets pin rev: v2.21.1.
  • The changelog has a v2.21.1 entry (three fixes) and a Highlights row, since the length rules now judge subjects differently.
  • CC004 gets a "Not counted" part: the (#123) a squash merge adds, and commits by dependabot[bot] and renovate[bot]. CC005 points to it.
  • The subject_max_length and subject_min_length rows in "Every option" say the same.

What the released 2.21.1 prints:

$ echo "fix: return 404 if no member left after pick and omit when retrieving an entity (#1698)" | commit-check -m
$ echo $?
0
$ echo "feat: <80 characters> (#1698)" | commit-check -m
✖ CC004 subject-max-length failed: feat: aaaa…aaaa (#1698)
  Subject is 86 characters, not counting "(#1698)"; it must be at most 80 characters
  Suggest: Shorten the subject by 6 characters, to 80 or fewer
$ echo "chore(deps): Bump org.zalando:logbook-spring-boot-webflux-autoconfigure from 4.0.3 to 4.0.4" | GIT_AUTHOR_NAME='dependabot[bot]' commit-check -m
⊘ skipped (not validated): subject-max-length

2.21.0 failed the first and third.

How

  • tests/docs_sync_test.py passes against the installed 2.21.1 (18 tests) and mkdocs build --strict is clean.
  • Blog posts keep their pins, as AGENTS.md asks.

Summary by CodeRabbit

  • Bug Fixes

    • Subject-length checks now exclude GitHub squash-merge suffixes and are skipped for Dependabot and Renovate commits.
    • Force-pushed commits not present in the local clone are checked against push and file rules.
  • Documentation

    • Updated configuration examples to use version 2.21.1 and clarified the subject-length exceptions.

@netlify

netlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 561aa63
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6afcec8888ddd94748d4b343
😎 Deploy Preview https://deploy-preview-87--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.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Nov 18, 2026 — with Claude
@coderabbitai

coderabbitai Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Explain Change →

Walkthrough

The documentation adds v2.21.1 release notes, describes subject-length exclusions for squash-merge suffixes and dependency-bot commits, and updates pre-commit examples to use v2.21.1.

Changes: v2.21.1 documentation

Layer / File(s) Summary
Document v2.21.1 changes
docs/changelog.md, docs/configuration.md, docs/rules.md
The changelog, configuration reference, and rule descriptions document the squash-merge suffix and dependency-bot exclusions. The changelog also describes checks for pushed commits that are absent from the clone.
Update pre-commit example revisions
docs/compare/tools.md, docs/configuration.md, docs/example.md, docs/guides/pre-commit.md
Pre-commit examples now use revision v2.21.1.

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

Change: Other

Suggested labels: documentation

Merge Risk: Low · up to 561aa

The docs change describes v2.21.1 behavior slightly more broadly than the tool implements it. The suffix wording, bot identification for supplied messages, and forced-push coverage should be tightened before merge, but nothing here affects runtime behavior.

Pre-merge checks: Passed 2

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names two changes that appear in the changeset: the pin to v2.21.1 across documentation examples (docs/configuration.md, docs/example.md, docs/guides/pre-commit.md, docs/compare/tools.md) an…
Full details: Title check

Explanation

The title names two changes that appear in the changeset: the pin to v2.21.1 across documentation examples (docs/configuration.md, docs/example.md, docs/guides/pre-commit.md, docs/compare/tools.md) and the CC004 documentation of the squash-merge suffix and bot skip (docs/rules.md). The changelog entry for v2.21.1 is also consistent with the title. The title is specific and accurate, though it omits the changelog and CC005 documentation updates, which is acceptable.

  • 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

@shenxianpeng shenxianpeng self-assigned this Nov 18, 2026
@shenxianpeng
shenxianpeng merged commit 9c806a2 into main Nov 18, 2026
7 of 8 checks passed
@shenxianpeng
shenxianpeng deleted the docs/pin-v2.21.1 branch November 18, 2026 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant