You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 4295029
Browse filesBrowse the repository at this point in the historyBrowse files
docs: update sample output to v2.20.4 and add two changelog entries (#83)
**Before:** The site showed the failure output of v2.20.2 and earlier in
18 samples on six pages, the homepage included, and the changelog
stopped at v2.20.2 while PyPI has v2.20.4.
```text
CC001 message check failed ==> updated the parser
The commit message should follow Conventional Commits. See https://www.conventionalcommits.org
Suggest: Use <type>(<scope>): <description>, where <type> is one of: feat, fix, docs, ...
Docs: https://commit-check.com/rules/#cc001
```
**After:** Every sample outside the blog is what 2.20.4 prints, and the
changelog has entries for v2.20.3 and v2.20.4 with a Highlights row for
2.20.3.
```text
✖ Commit rejected by Commit Check · 1 check failed
✖ CC001 message failed: updated the parser
The commit message should follow Conventional Commits. See https://www.conventionalcommits.org
Suggest: Use <type>(<scope>): <description>, where <type> is one of: feat, fix, docs, style, refactor, test, chore, perf, build, ci
Docs: https://commit-check.com/rules/#cc001
```
v2.20.3 replaced the ASCII banner with a one-line header and an indented
block per failed check; this brings the site into step with it.
## How
- **Samples.** Each one was run again with commit-check 2.20.4 (the two
hook transcripts with pre-commit 4.7.0, `rev: v2.20.4`) and pasted as
printed: `getting-started.md`, `example.md`, `troubleshoot.md`,
`guides/policies.md` and the two at the top of `rules.md` show the whole
output; the per-rule examples in `rules.md` stay three-line excerpts, as
before.
- **Homepage.** The hero terminal and the numbered breakdown follow the
same transcript. The hero is one line taller (415px against 394px at
desktop width).
- **Wording.** `--no-banner` now hides a header, not ASCII art
(`example.md`, `configuration.md`). The table in Getting started names
the value without `==>`.
- **Three short notes** for behaviour fixed in these releases, each
where the rule is documented: trailers alone are not a body (CC011), the
author read before a commit exists is `GIT_AUTHOR_*`, then `author.*`,
then `user.*` (CC017 and Checking the committer), and CC017's advice for
a message that is not committed yet.
- **Changelog.** One sentence per change, each linked to its page and
pull request. 2.20.4 only fixes bugs, so it gets no Highlights row.
- **Test.** `_SAMPLE_FAILURE` in `tests/docs_sync_test.py` matched only
the old `check failed ==>` line, so after this change it would have
checked nothing. It now reads both forms. Breaking a rule name in a
sample (`author-nam`) makes the test fail again.
- **Blog posts are untouched.** They are dated records and keep the
output of their day.
## Checks
- `mkdocs build --strict` passes.
- `python -m pytest tests/ -q`: 18 passed, against commit-check 2.20.4.
- No horizontal overflow at 390px wide on the homepage and the six
changed guide and reference pages.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
<!-- coderabbit-ai-generated:v1 -->
## Summary by CodeRabbit
* **Documentation**
* Updated examples across the guides, rules, and troubleshooting pages
to reflect the current structured failure and warning output.
* Clarified how author identity is selected and that trailers alone do
not satisfy the non-empty commit-body requirement.
* Added changelog entries for versions 2.20.3 and 2.20.4.
* **Tests**
* Updated documentation checks to accept both legacy and current failure
or warning output formats.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/changelog.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ page that documents it.
11
11
12
12
| Version | What changed | Documented in |
13
13
|---|---|---|
14
+
|[2.20.3](#v2203)| Failures print a one-line header and an indented block per check, in place of the ASCII banner; an agent skill for coding agents |[Getting started](getting-started.md#2-watch-it-reject-something) · [With AI coding agents](guides/ai-agents.md#tell-the-agent)|
14
15
|[2.20.1](#v2201)|`--ai-attribution-only` checks a pull request description against your AI policy; JSON lists the AI tools found; more AI marks recognised |[Checking a pull request description](guides/policies.md#checking-a-pull-request-description) · [CC013](rules.md#cc013)|
15
16
|[2.20.0](#v2200)| Commits authored by an AI tool rejected; subject length `0` turns the rule off; Python 3.11+ required |[CC017](rules.md#cc017) · [CC013](rules.md#cc013) · [CC004](rules.md#cc004)|
16
17
|[2.19.5](#v2195)| GitHub merge queue branches accepted by default; aider's default co-author trailer recognised; exit 2 when git cannot read the repository |[CC201](rules.md#cc201) · [CC013](rules.md#cc013) · [Exit codes](troubleshoot.md#exit-codes)|
@@ -38,6 +39,29 @@ page that documents it.
38
39
|[2.5.0](#v250)| Organization-wide config with `inherit_from`|[Across an organization](guides/organization.md)|
39
40
|[2.0.0](#v200)| Configuration moved from YAML to TOML — breaking |[Migrating from v1](migration.md)|
40
41
42
+
## v2.20.4 (2026-11-10) { #v2204 }
43
+
44
+
### Fixed
45
+
46
+
*`require_body` no longer takes trailers alone, such as the `Signed-off-by:` line from `git commit -s`, for a body. ([CC011](rules.md#cc011), [#689](https://github.com/commit-check/commit-check/pull/689))
47
+
*`ignore_authors` written as one string is split on commas, instead of skipping any author whose name is part of it. ([Every option](configuration.md#every-option), [#689](https://github.com/commit-check/commit-check/pull/689))
48
+
*`--author-name` and `--author-email` honour `git commit --author` and the `author.name` and `author.email` settings. ([Checking the committer](example.md#checking-the-committer), [#689](https://github.com/commit-check/commit-check/pull/689))
49
+
50
+
## v2.20.3 (2026-11-10) { #v2203 }
51
+
52
+
### Added
53
+
54
+
* An agent skill teaches coding agents to check a message before they commit. ([With AI coding agents](guides/ai-agents.md#tell-the-agent), [#679](https://github.com/commit-check/commit-check/pull/679), [#686](https://github.com/commit-check/commit-check/pull/686))
55
+
56
+
### Changed
57
+
58
+
* A failure prints a one-line header and an indented block per check, in place of the ASCII banner. ([Getting started](getting-started.md#2-watch-it-reject-something), [#682](https://github.com/commit-check/commit-check/pull/682))
59
+
60
+
### Fixed
61
+
62
+
* CC017 on a message that is not committed yet suggests setting your own `user.name` and `user.email`, not amending. ([CC017](rules.md#cc017), [#685](https://github.com/commit-check/commit-check/pull/685))
63
+
*`--ai-attribution-only` with no text piped in passes, instead of judging `HEAD`. ([Guide](guides/policies.md#checking-a-pull-request-description), [#684](https://github.com/commit-check/commit-check/pull/684))
<p><spanclass="cc-mark">3</span><spanclass="cc-t-dim">The commit message should follow Conventional Commits. See https://www.conventionalcommits.org</span></p>
418
418
<p><spanclass="cc-mark">4</span><span><spanclass="cc-t-blue">Suggest:</span> Use "<spanclass="cc-t-pass cc-b">fix: add streaming support</span>"</span></p>
0 commit comments