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 e08a5c8
Browse filesBrowse the repository at this point in the historyBrowse files
docs: pin v2.19.4 and add its changelog entry (#66)
Brings the site in step with v2.19.4, published 2026-10-29
([release](https://github.com/commit-check/commit-check/releases/tag/v2.19.4),
on PyPI).
## Before / After
`python -m pytest tests/ -q` with `commit-check==2.19.4` installed:
| | Result |
|---|---|
| Before (`main`) | ❌ 2 failed, 16 passed:
`test_pinned_revisions_match_the_released_version`,
`test_documented_defaults_match_the_runtime` |
| After (this branch) | ✅ 18 passed |
What a reader sees:
| Page | Before | After |
|---|---|---|
| pre-commit snippets (configuration, example, pre-commit guide ×3) |
`rev: v2.19.3` | `rev: v2.19.4` |
| Configuration → `allow_branch_types` default | `… "copilot", "cursor",
"dependabot", "renovate"` | `… "copilot", "cursor", "agents",
"dependabot", "renovate"`, and the description names `agents` (the
prefix VS Code's Agents window uses) |
| Rules → CC201 options | default list without `agents` | names `agents`
among the defaults |
| Rules → CC013, Policy guides | trailers listed up to Copilot's
`Agent-Logs-Url:` | also Cursor's `Made-with: Cursor` |
| Changelog | latest entry v2.19.3 | v2.19.4 (2026-10-29) entry and a
Highlights row |
## Changes
- Pins: `docs/configuration.md`, `docs/example.md`,
`docs/guides/pre-commit.md` (blog posts untouched, as AGENTS.md asks).
- `agents` in the default branch types, from
commit-check/commit-check#645: `docs/configuration.md` (Every option)
and `docs/rules.md` (CC201). The spec-strict config on CC201 is
unchanged: the Conventional Branch spec does not list `agents` yet.
- Cursor's `Made-with: Cursor` trailer, from
commit-check/commit-check#643, which noted the site could name it once
released: `docs/rules.md` (CC013) and `docs/guides/policies.md`.
- `docs/changelog.md`: v2.19.4 entry with its release date, and a
Highlights row, since the release changes what passes.
`mkdocs build --strict` passes locally (no warnings).
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
<!-- coderabbit-ai-generated:v1 -->
## Summary by CodeRabbit
* **Documentation**
* Updated the changelog and policy guidance to describe recognition of
Cursor’s `Made-with:` trailer. It is rejected when the `forbid` policy
is enabled and corrected to `Assisted-by: Cursor` under `disclose`;
other `Made-with:` values are unaffected.
* Updated configuration and rule documentation to show `agents` as an
accepted default branch prefix.
* Updated pre-commit examples to use Commit Check v2.19.4.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
|[2.19.3](#v2193)| A quoted `"false"` for a true/false setting refused instead of read as true |[Every option](configuration.md#every-option)|
15
16
|[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)|
16
17
|[2.19.1](#v2191)|`develop` accepted by default; stricter merge-subject, fixup, WIP and sign-off checks |[CC201](rules.md#cc201) · [CC001](rules.md#cc001) · [CC009](rules.md#cc009)|
@@ -34,6 +35,29 @@ below and to the page that documents the feature properly.
34
35
|[2.5.0](#v250)| Organization-wide config with `inherit_from`|[Across an organization](guides/organization.md)|
35
36
|[2.0.0](#v200)| Configuration moved from YAML to TOML — breaking |[Migrating from v1](migration.md)|
36
37
38
+
## v2.19.4 (2026-10-29) { #v2194 }
39
+
40
+
### Changed
41
+
42
+
***`agents/` branches are accepted by default** — VS Code's Agents window
43
+
names its branches `agents/<description>`, and its users cannot change the
44
+
prefix, so [CC201](rules.md#cc201) failed them unless `allow_branch_types`
45
+
listed `agents`. It is now in the default list. The Conventional Branch
46
+
specification plans to accept it as an alias of `ai`
@@ -404,7 +404,7 @@ the same thing twice, so read the description rather than the cell:
404
404
| commit | ai_disclosure_trailers | list[str] | ["Assisted-by", "Generated-by"] | The trailers that disclose AI assistance under `"disclose"`. The first one is what a correction is written with. Listing `Co-authored-by` says the project accepts the tool as a co-author, and CC015 then passes. `Signed-off-by` is refused: only a person can certify the DCO. |
405
405
| commit | ai_disclosure_pattern | str | "" (any value) | A regex the disclosure trailer's value must match under `"disclose"`, e.g. `'^\S+/\S+$'` for an `agent/model` format. Empty accepts any value, but a trailer with no value at all is reported whatever the pattern is. |
| 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", "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`) 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. |
407
+
| 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. |
408
408
| 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
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. |
410
410
| branch | require_rebase_target | str | "" (no requirement) | Target branch for rebase requirement. If not set, no rebase validation is performed. |
0 commit comments