Skip to content

Commit e08a5c8

Browse files
authored
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 -->
1 parent e421eae commit e08a5c8

6 files changed

Lines changed: 38 additions & 13 deletions

File tree

‎docs/changelog.md‎

Lines changed: 24 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.4](#v2194) | `agents/` branches accepted by default; Cursor's `Made-with: Cursor` trailer recognised | [CC201](rules.md#cc201) · [CC013](rules.md#cc013) |
1415
| [2.19.3](#v2193) | A quoted `"false"` for a true/false setting refused instead of read as true | [Every option](configuration.md#every-option) |
1516
| [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) |
1617
| [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.
3435
| [2.5.0](#v250) | Organization-wide config with `inherit_from` | [Across an organization](guides/organization.md) |
3536
| [2.0.0](#v200) | Configuration moved from YAML to TOML — breaking | [Migrating from v1](migration.md) |
3637

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`
47+
([conventional-branch#196](https://github.com/conventional-branch/conventional-branch/issues/196)).
48+
This only widens what passes.
49+
See PR [#645](https://github.com/commit-check/commit-check/pull/645).
50+
51+
### Fixed
52+
53+
* **[CC013](rules.md#cc013)–[CC016](rules.md#cc016) recognise Cursor's
54+
`Made-with: Cursor` trailer** — Cursor marks the commits it writes with it,
55+
and every policy let it through. It now counts as Cursor's own mark, like
56+
the Copilot coding agent's `Agent-Logs-Url:`: `forbid` rejects it, and under
57+
`disclose` the correction appends `Assisted-by: Cursor`. Other `Made-with:`
58+
values are left alone.
59+
See PR [#643](https://github.com/commit-check/commit-check/pull/643).
60+
3761
## v2.19.3 (2026-10-21) { #v2193 }
3862

3963
### Fixed

‎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.3
277+
rev: v2.19.4
278278
hooks:
279279
- id: check-message
280280
args:
@@ -404,7 +404,7 @@ the same thing twice, so read the description rather than the cell:
404404
| 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. |
405405
| 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. |
406406
| branch | conventional_branch | bool | true | Enforce Conventional Branch specification. |
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", "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. |
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). |
409409
| 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. |
410410
| branch | require_rebase_target | str | "" (no requirement) | Target branch for rebase requirement. If not set, no rebase validation is performed. |

‎docs/example.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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.3
165+
rev: v2.19.4
166166
hooks:
167167
- id: check-no-force-push
168168
stages: [pre-push]

‎docs/guides/policies.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ Recognised signatures are co-author and sign-off lines naming Claude Code,
135135
GitHub Copilot, Codex, Gemini, Cursor, Devin, Aider, Windsurf, Tabby, Amp,
136136
OpenHands, Factory Droid and Jules, the disclosure trailers `Assisted-by:` and
137137
`Generated-by:`, vendor marks such as `🤖 Generated with Claude Code`, Amp's
138-
`Amp-Thread-ID:` and the Copilot coding agent's `Agent-Logs-Url:`, and generic
139-
AI model names. This is the
138+
`Amp-Thread-ID:`, the Copilot coding agent's `Agent-Logs-Url:` and Cursor's
139+
`Made-with: Cursor`, and generic AI model names. This is the
140140
position [Kubernetes](https://www.kubernetes.dev/docs/guide/pull-requests/)
141141
takes — no AI trailers in the history, disclosure in the pull request
142142
instead.

‎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.3
11+
rev: v2.19.4
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.3
71+
rev: v2.19.4
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.3
93+
rev: v2.19.4
9494
hooks:
9595
- id: check-message
9696
args: [--fix]

‎docs/rules.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -565,9 +565,9 @@ Rejects a commit whose message carries any AI attribution: a co-author or
565565
sign-off line naming Claude Code, Copilot, Codex, Gemini, Cursor, Devin,
566566
Aider, Windsurf, Tabby, Amp, OpenHands, Factory Droid or Jules, a disclosure
567567
trailer such as `Assisted-by:` or `Generated-by:`, a vendor's own mark such
568-
as `🤖 Generated with Claude Code`, Amp's `Amp-Thread-ID:` trailer or the
569-
`Agent-Logs-Url:` trailer the Copilot coding agent adds, and generic AI model
570-
names. Copilot is also recognised by its account's
568+
as `🤖 Generated with Claude Code`, Amp's `Amp-Thread-ID:` trailer, the
569+
`Agent-Logs-Url:` trailer the Copilot coding agent adds or Cursor's
570+
`Made-with: Cursor`, and generic AI model names. Copilot is also recognised by its account's
571571
`N+Copilot@users.noreply.github.com` address, so the coding agent's
572572
`copilot-swe-agent[bot]` co-author line counts under any display name.
573573

@@ -827,8 +827,9 @@ feature/role-caching
827827
a superset of the specification: the spec's types (`feature`, `bugfix`,
828828
`hotfix`, `release`, `chore`, their aliases `feat` and `fix`, and the AI
829829
agent prefixes `ai`, `claude`, `codex`, `copilot` and `cursor`), plus the
830-
other Conventional Commit types and the bot prefixes `dependabot` and
831-
`renovate`. Set it explicitly for strict spec-only validation.
830+
other Conventional Commit types, `agents` (the prefix VS Code's Agents
831+
window uses) and the bot prefixes `dependabot` and `renovate`. Set it
832+
explicitly for strict spec-only validation.
832833
* `branch.require_description_grammar` — set to `true` to hold the
833834
description to the specification's grammar, so `feature/Add_Login`,
834835
`feature/new--login` and `feature/a/b` are rejected. Off by default,

0 commit comments

Comments
 (0)