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 fb80e01
Browse filesBrowse the repository at this point in the historyBrowse files
docs: bring guides, rules and examples in step with commit-check 2.19.2 (#57)
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.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## 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.
<!-- 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/compare/tools.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ for the current state. GitHub's own rulesets are on
16
16
|[commitcheck](https://github.com/marketplace/commitcheck)| A hosted App that applies one regular expression, set in its web admin | Commit message, pull request title or description, by regex | GitHub App | Free for public repositories; $25 a month for private ones |
17
17
|[DCO app](https://github.com/apps/dco) and [DCO-2](https://github.com/cncf/dco2)| The sign-off check the Linux kernel and the CNCF use, with a remediation flow for missing sign-offs |`Signed-off-by` trailers | GitHub App | Free, open source |
18
18
|[PRLint](https://github.com/ewolfe/prlint), [PR Title Checker](https://github.com/marketplace/actions/pr-title-checker)| Regular expressions over pull request fields | Title, body, labels, branch | App / Action | Free, open source |
19
-
|**Commit Check**| One rule engine, [documented rule by rule](../rules.md), run as a hook, a CLI, an Action, a hosted App or an MCP tool | Commit message, branch name, author name and email, sign-off, AI attribution, force pushes, file size and paths, tag names; the squash message of a pull request | All of the above | Free, open source; the App's private organization repositories move to a paid plan later |
19
+
|**Commit Check**| One rule engine, [documented rule by rule](../rules.md), run as a hook, a CLI, an Action, a hosted App or an MCP tool | Commit message, branch name, author name and email, sign-off, AI attribution, force pushes, file size and paths, tag names; the pull request title (Action) and the squash message of a pull request (App)| All of the above | Free, open source; the App's private organization repositories move to a paid plan later |
Copy file name to clipboardExpand all lines: docs/configuration.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ flag overrides both for a single run.
23
23
| `--message` | Conventional Commits ([CC001](rules.md#cc001)), subject lengths of 5–80 characters ([CC004](rules.md#cc004), [CC005](rules.md#cc005)), and an allow-list of ten commit types |
24
24
| `--branch` | Conventional Branch ([CC201](rules.md#cc201)) and an allow-list of twenty-one branch types |
25
25
| `--author-name` / `--author-email` | The built-in name and email patterns ([CC101](rules.md#cc101), [CC102](rules.md#cc102)) |
26
+
| `--tag` | SemVer tag names, with an optional leading `v` ([CC401](rules.md#cc401)) |
26
27
27
28
Off until you turn them on: subject capitalization, imperative mood,
28
29
required body and signoff, and rebase requirements.
@@ -89,8 +90,9 @@ It is a warning, not an error: the exit code and the JSON on stdout do not
89
90
change. The top-level `warn` list and the GitHub App's
90
91
[`[jira]`](guides/github-app.md#jira-ticket-references) and
<p><spanclass="cc-mark">3</span><spanclass="cc-t-dim">The commit message should follow Conventional Commits.</span></p>
417
+
<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