Skip to content

docs: Update commit-check version to v2.16.0 #561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 4 commits into from
Aug 31, 2026
Merged

docs: Update commit-check version to v2.16.0 #561

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
106d958
docs: Update commit-check version to v2.16.0
shenxianpeng Aug 31, 2026
f1cfc23
Update README.md
shenxianpeng Aug 31, 2026
fa4bda1
Update README.md
shenxianpeng Aug 31, 2026
9bb639b
docs: drop the shipped-later notes now the pins name v2.16.0
claude Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ commit-check --message --branch
```yaml
repos:
- repo: https://github.com/commit-check/commit-check
rev: v2.15.1
rev: v2.16.0
Comment thread
coderabbitai[bot] marked this conversation as resolved.
hooks:
- id: check-message
- id: check-branch
Expand Down Expand Up @@ -195,7 +195,7 @@ commit-check --message
# In pre-commit hooks (.pre-commit-config.yaml)
repos:
- repo: https://github.com/commit-check/commit-check
rev: v2.15.1
rev: v2.16.0
hooks:
- id: check-message
args:
Expand Down Expand Up @@ -225,7 +225,7 @@ commit-check --no-force-push
# In pre-commit hooks (.pre-commit-config.yaml)
repos:
- repo: https://github.com/commit-check/commit-check
rev: v2.15.1
rev: v2.16.0
hooks:
- id: check-no-force-push
stages: [pre-push]
Expand Down Expand Up @@ -257,16 +257,12 @@ commit-check --tag --tag-regex '^v\d+\.\d+\.\d+$'
# a push carries, from the pre-push ref metadata on stdin
repos:
- repo: https://github.com/commit-check/commit-check
rev: v2.15.1
rev: v2.16.0
hooks:
- id: check-tag
stages: [pre-push]
```

> [!NOTE]
> The `check-tag` hook ships in the first release after v2.15.1 — bump `rev`
> to that release once it is published.

### Check Committed Files

Use `--files` to police metadata about the files a commit touches — never
Expand Down Expand Up @@ -301,16 +297,12 @@ commit-check --files --rev abc1234
# (a tag on already-pushed history adds nothing, so it is skipped)
repos:
- repo: https://github.com/commit-check/commit-check
rev: v2.15.1
rev: v2.16.0
hooks:
- id: check-files
stages: [pre-push]
```

> [!NOTE]
> Like `check-tag`, the `check-files` hook ships in the first release after
> v2.15.1 — bump `rev` to that release once it is published.

A commit that only deletes files is reported as skipped — removing a file
adds nothing to police. Content scanning (entropy, token detection) is
deliberately out of scope: pair these checks with a scanner like gitleaks
Expand Down