Skip to content

Commit f70a92b

Browse files
authored
docs: add FreeBSD to the homepage, and pin v2.19.5 (#73)
FreeBSD's [freebsd/atf](https://github.com/freebsd/atf) now runs Commit Check in CI: the Action on every pull request to `master` ([`.github/workflows/commit-check.yaml`](https://github.com/freebsd/atf/blob/331d7e38516cbf490fa2e88fbab019f1e76be6fd/.github/workflows/commit-check.yaml), added 2026-11-04) plus the pre-commit hooks at v2.19.5, with its own [`commit-check.toml`](https://github.com/freebsd/atf/blob/331d7e38516cbf490fa2e88fbab019f1e76be6fd/commit-check.toml) (including `ai_attribution = "disclose"` with `Assisted-by`). This adds FreeBSD to the homepage's "In the CI of" row, right after Apache. At 390 px the row wraps as before. ## Before vs after ![Homepage "In the CI of" row, before and after](https://github.com/commit-check/commit-check.com/raw/157b362258a194c5f6cfa176f314ff3950690ff4/pr-assets/freebsd-before-after.png) The screenshot was committed and then removed on this branch, so the squash merge does not include it. ## Site brought in step with v2.19.5 v2.19.5 was published 2026-11-04, so `docs-sync` failed on this PR (and would on `main`) with the v2.19.4 pins. As AGENTS.md asks, it is fixed in the same change (commit b5bf920): | Page | Before | After | |---|---|---| | pre-commit snippets (configuration, example, compare/tools, pre-commit guide ×3) | `rev: v2.19.4` | `rev: v2.19.5` | | Always-accepted branch names (configuration, example, CC201) | `main`, `master`, `develop`, `HEAD`, `PR-*` | also `gh-readonly-queue/*` (commit-check#653) | | Troubleshooting → Exit codes, `2` | bad usage, unresolved `--rev`, config errors | also a directory git cannot read (commit-check#654) | | Changelog | latest entry v2.19.4 | v2.19.5 (2026-11-04) entry for commit-check#652, #653, #654 and a Highlights row | `python -m pytest tests/ -q` with `commit-check==2.19.5`: before 1 failed, 17 passed (`test_pinned_revisions_match_the_released_version`); after 18 passed. `mkdocs build --strict` passes. --------- Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
1 parent 5b562e9 commit f70a92b

8 files changed

Lines changed: 44 additions & 12 deletions

File tree

‎docs/changelog.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ below and to the page that documents the feature properly.
1111

1212
| Version | What changed | Documented in |
1313
|---|---|---|
14+
| [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) |
1415
| [2.19.4](#v2194) | `agents/` branches accepted by default; Cursor's `Made-with: Cursor` trailer recognised | [CC201](rules.md#cc201) · [CC013](rules.md#cc013) |
1516
| [2.19.3](#v2193) | A quoted `"false"` for a true/false setting refused instead of read as true | [Every option](configuration.md#every-option) |
1617
| [2.19.2](#v2192) | Copilot coding agent commits recognised; config values of the wrong type refused; commit text printed inert | [CC013](rules.md#cc013) · [Every option](configuration.md#every-option) · [Color and links](example.md#color-and-links) |
@@ -35,6 +36,36 @@ below and to the page that documents the feature properly.
3536
| [2.5.0](#v250) | Organization-wide config with `inherit_from` | [Across an organization](guides/organization.md) |
3637
| [2.0.0](#v200) | Configuration moved from YAML to TOML — breaking | [Migrating from v1](migration.md) |
3738

39+
## v2.19.5 (2026-11-04) { #v2195 }
40+
41+
### Fixed
42+
43+
* **GitHub merge queue branches are accepted by default** — the merge queue
44+
runs its `merge_group` checks on a branch it creates,
45+
`gh-readonly-queue/<base>/pr-<N>-<sha>`, and [CC201](rules.md#cc201)
46+
rejected it. A repository with a merge queue and Commit Check as a required
47+
check failed every queue entry. The name is now accepted next to `main`,
48+
`master`, `develop`, `HEAD` and `PR-*`, whatever `allow_branch_types` or
49+
`allow_branch_names` say.
50+
See PR [#653](https://github.com/commit-check/commit-check/pull/653).
51+
52+
* **[CC013](rules.md#cc013)–[CC016](rules.md#cc016) recognise aider's default
53+
co-author trailer** — since v0.85 aider adds
54+
`Co-authored-by: aider (<model>) <aider@aider.chat>` to every commit, and the
55+
model in parentheses kept it from matching, so `forbid` and `disclose` let
56+
it through. It is now matched by its address, whatever model it names, and
57+
under `disclose` the correction is `Assisted-by: aider (<model>)`.
58+
See PR [#652](https://github.com/commit-check/commit-check/pull/652).
59+
60+
* **A directory git cannot read stops the run with exit 2** — outside a
61+
repository, or in one git refuses for "dubious ownership" (common in
62+
containers and on self-hosted agents), every check was skipped and the run
63+
exited 0, so CI went green without checking anything. Now git's own reason
64+
is printed, including its `safe.directory` hint, and the run exits 2. A
65+
piped or file message, and a repository with no commits yet, work as before.
66+
See PR [#654](https://github.com/commit-check/commit-check/pull/654) and
67+
[Exit codes](troubleshoot.md#exit-codes).
68+
3869
## v2.19.4 (2026-10-29) { #v2194 }
3970

4071
### Changed

‎docs/compare/tools.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Replace the hook:
6565
```yaml title=".pre-commit-config.yaml"
6666
repos:
6767
- repo: https://github.com/commit-check/commit-check
68-
rev: v2.19.4
68+
rev: v2.19.5
6969
hooks:
7070
- id: check-message
7171
```

‎docs/configuration.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ Used from a hook definition, with no config file anywhere in the repository:
274274
```yaml title=".pre-commit-config.yaml"
275275
repos:
276276
- repo: https://github.com/commit-check/commit-check
277-
rev: v2.19.4
277+
rev: v2.19.5
278278
hooks:
279279
- id: check-message
280280
args:
@@ -406,7 +406,7 @@ the same thing twice, so read the description rather than the cell:
406406
| branch | conventional_branch | bool | true | Enforce Conventional Branch specification. |
407407
| branch | allow_branch_types | list[str] | ["feature", "bugfix", "hotfix", "release", "chore", "feat", "fix", "build", "ci", "docs", "perf", "refactor", "style", "test", "ai", "claude", "codex", "copilot", "cursor", "agents", "dependabot", "renovate"] | Allowed branch types when `conventional_branch` is true. The default is a superset of the [Conventional Branch spec](https://conventionalbranch.org/): the spec's types (`feature`, `bugfix`, `hotfix`, `release`, `chore`, their aliases `feat` and `fix`, and the AI agent prefixes `ai`, `claude`, `codex`, `copilot`, `cursor`) plus the other Conventional Commit types (`build`, `ci`, `docs`, `perf`, `refactor`, `style`, `test`), `agents` (the prefix VS Code's Agents window uses) and bot prefixes (`dependabot`, `renovate`). For strict spec-only validation, set this option explicitly to the spec's types; [CC201](rules.md#cc201) has the full config. |
408408
| branch | require_description_grammar | bool | false | Also hold the description after `<type>/` to the Conventional Branch grammar: lowercase letters and digits, words joined by single hyphens, dots only inside a word. Off by default, because bot branches such as `dependabot/npm_and_yarn/lodash-4.17.21` do not follow it. See [CC201](rules.md#cc201). |
409-
| branch | allow_branch_names | list[str] | [] (empty list) | Additional standalone branch names allowed when conventional_branch is true (e.g., ["staging", "production"]). By default, main, master, develop, HEAD, and PR-* are always allowed. |
409+
| branch | allow_branch_names | list[str] | [] (empty list) | Additional standalone branch names allowed when conventional_branch is true (e.g., ["staging", "production"]). By default, main, master, develop, HEAD, PR-* and gh-readonly-queue/* (GitHub merge queue branches) are always allowed. |
410410
| branch | require_rebase_target | str | "" (no requirement) | Target branch for rebase requirement. If not set, no rebase validation is performed. |
411411
| push | allow_force_push | bool | true | Allow force pushes. Set to `false` to block force pushes when used as a pre-push hook or with `--no-force-push`. |
412412
| branch | ignore_authors | list[str] | [] (none ignored) | List of authors to ignore (i.e., always allow). |

‎docs/example.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ $ commit-check --branch
112112
```
113113

114114
Runs [CC201](rules.md#cc201), and [CC202](rules.md#cc202) if
115-
`require_rebase_target` is set. `main`, `master`, `develop`, `HEAD` and `PR-*` are
116-
always accepted; everything else needs a `<type>/<description>` shape:
115+
`require_rebase_target` is set. `main`, `master`, `develop`, `HEAD`, `PR-*` and
116+
`gh-readonly-queue/*` (GitHub merge queue branches) are always accepted; everything else needs a `<type>/<description>` shape:
117117

118118
```text
119119
fix/empty-config-crash
@@ -162,7 +162,7 @@ pushed:
162162
```yaml title=".pre-commit-config.yaml"
163163
repos:
164164
- repo: https://github.com/commit-check/commit-check
165-
rev: v2.19.4
165+
rev: v2.19.5
166166
hooks:
167167
- id: check-no-force-push
168168
stages: [pre-push]

‎docs/guides/pre-commit.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Add Commit Check to `.pre-commit-config.yaml`:
88
```yaml title=".pre-commit-config.yaml"
99
repos:
1010
- repo: https://github.com/commit-check/commit-check
11-
rev: v2.19.4
11+
rev: v2.19.5
1212
hooks:
1313
- id: check-message
1414
- id: check-branch
@@ -68,7 +68,7 @@ Options can be passed as hook arguments, which keeps everything in one file:
6868
```yaml title=".pre-commit-config.yaml"
6969
repos:
7070
- repo: https://github.com/commit-check/commit-check
71-
rev: v2.19.4
71+
rev: v2.19.5
7272
hooks:
7373
- id: check-message
7474
args:
@@ -90,7 +90,7 @@ colon, and lets the commit through:
9090
```yaml title=".pre-commit-config.yaml"
9191
repos:
9292
- repo: https://github.com/commit-check/commit-check
93-
rev: v2.19.4
93+
rev: v2.19.5
9494
hooks:
9595
- id: check-message
9696
args: [--fix]

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ conventional_branch = <span class="cc-t-pass">true</span></div>
428428
<li><b>160+</b><span>repositories run the Action</span></li>
429429
<li><b>Apache</b><span>allowlists the Action for its projects' CI</span></li>
430430
</ul>
431-
<p class="cc-users"><span>In the CI of</span><a href="https://github.com/apache">Apache</a><a href="https://github.com/TexasInstruments">Texas Instruments</a><a href="https://github.com/mila-iqia">Mila</a><a href="https://github.com/istio-ecosystem">Istio Ecosystem</a><a href="https://github.com/OpenDriveLab">OpenDriveLab</a><a href="https://github.com/commit-check/commit-check-action/network/dependents">and more →</a></p>
431+
<p class="cc-users"><span>In the CI of</span><a href="https://github.com/apache">Apache</a><a href="https://github.com/freebsd">FreeBSD</a><a href="https://github.com/TexasInstruments">Texas Instruments</a><a href="https://github.com/mila-iqia">Mila</a><a href="https://github.com/istio-ecosystem">Istio Ecosystem</a><a href="https://github.com/OpenDriveLab">OpenDriveLab</a><a href="https://github.com/commit-check/commit-check-action/network/dependents">and more →</a></p>
432432
</div>
433433
</section>
434434

‎docs/rules.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -802,7 +802,8 @@ Checks that the current branch name follows the
802802
[Conventional Branch](https://conventionalbranch.org/) specification:
803803
`<type>/<description>`.
804804

805-
`main`, `master`, `develop`, `HEAD`, and `PR-*` are always accepted.
805+
`main`, `master`, `develop`, `HEAD`, `PR-*`, and the `gh-readonly-queue/*`
806+
branches GitHub's merge queue creates are always accepted.
806807

807808
By default only the type is checked, and any description after the `/` is
808809
accepted. With `require_description_grammar` the description has to follow

‎docs/troubleshoot.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ broken policy from a bad commit. Commit Check keeps them apart:
107107
|---|---|
108108
| `0` | Every enforced check passed, or every check was skipped. |
109109
| `1` | A check failed. This is a verdict on the commit. |
110-
| `2` | The run could not start, so nothing was validated: bad usage, a `--rev` that does not resolve, a setting whose regex does not compile or whose value has the wrong type, or a config file that is missing, is not valid TOML, or names an unknown rule. |
110+
| `2` | The run could not start, so nothing was validated: bad usage, a `--rev` that does not resolve, a directory git cannot read as a repository (not a repository, or refused for dubious ownership), a setting whose regex does not compile or whose value has the wrong type, or a config file that is missing, is not valid TOML, or names an unknown rule. |
111111

112112
A configuration error names the file it came from:
113113

0 commit comments

Comments
 (0)