Repository navigation
Commit ced8ec6
authored
docs: pin v2.20.5 and add its changelog entry (#84)
**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:
```console
$ 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
```
```console
$ 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.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
<!-- coderabbit-ai-generated:v1 -->
## 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.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>1 parent 8337fe5 commit ced8ec6
6 files changed
Lines changed: 24 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| 14 | + | |
14 | 15 | | |
15 | 16 | | |
16 | 17 | | |
| |||
39 | 40 | | |
40 | 41 | | |
41 | 42 | | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
42 | 55 | | |
43 | 56 | | |
44 | 57 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
| 68 | + | |
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
274 | 274 | | |
275 | 275 | | |
276 | 276 | | |
277 | | - | |
| 277 | + | |
278 | 278 | | |
279 | 279 | | |
280 | 280 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
144 | 144 | | |
145 | 145 | | |
146 | 146 | | |
147 | | - | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
148 | 150 | | |
149 | 151 | | |
150 | 152 | | |
| |||
167 | 169 | | |
168 | 170 | | |
169 | 171 | | |
170 | | - | |
| 172 | + | |
171 | 173 | | |
172 | 174 | | |
173 | 175 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
71 | | - | |
| 71 | + | |
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
| |||
90 | 90 | | |
91 | 91 | | |
92 | 92 | | |
93 | | - | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
753 | 753 | | |
754 | 754 | | |
755 | 755 | | |
756 | | - | |
757 | | - | |
758 | | - | |
| 756 | + | |
| 757 | + | |
759 | 758 | | |
760 | 759 | | |
761 | 760 | | |
| |||
0 commit comments