docs: bring the site in step with v2.18.3 - #50

Requested by Xianpeng · project thread

Before: the site described 2.18.2, while 2.18.3 is what pip install commit-check gets. The pre-commit snippets installed 2.18.2 and the changelog stopped there. --fix and the warning for a misspelt setting were documented nowhere. The GitLab, Bitbucket and Azure jobs piped the branch name into --branch, a workaround 2.18.3 no longer needs. The pre-commit guide's hook table had no check-tag or check-files, although the README sends readers there for them.

After: the site describes 2.18.3.

• Site in step with v2.18.3, per AGENTS.md: the four pre-commit pins move from v2.18.2 to v2.18.3. The changelog gains the v2.18.3 entry, dated 2026-10-07 (the GitHub release and the PyPI upload), with a Highlights row because the release adds user-visible behaviour.
• GitLab CI, Bitbucket and Azure Pipelines: each job runs a plain commit-check --branch, which reads the CI's own variables since feat: read the branch from GitLab, Bitbucket, Azure and Jenkins variables commit-check#600. A note keeps the piped form for 2.18.2 and older, which pinned installs still need.
• Command-line recipes: a "Fixing a message in place" section for --fix (feat: add --fix to correct a commit message in place commit-check#594), and a paragraph on how --branch names the branch on a detached checkout.
• Pre-commit hook: args: [--fix] on check-message. The hook table adds check-files and check-tag, pre-push hooks since 2.16.0, and gives check-message its full range, CC001–CC016 since 2.18.0; the App guide had the same stale range. A note says pre-commit runs no hook for a push that creates a ref without new commits, so a tag pushed on its own after its commit is never checked.
• Configuration: "Settings nothing reads", for the warning from feat: warn about config settings that nothing reads commit-check#593.

How: every sample is a transcript from 2.18.3. I ran --fix on a message file, on stdin, with --rev and with --dry-run, and ran the check-message hook with args: [--fix] through pre-commit at rev: v2.18.3; it recorded Fix: add streaming support as fix: add streaming support. For the branch step, a plain commit-check --branch on a detached checkout passed a valid name and failed bad_branch_name under each CI's variables, including both forms of Azure's source branch. For the push hooks, with pre-commit 4.6.2 at rev: v2.18.3: check-files rejected a 4 KB file over max_size = "1KB", check-tag rejected release-2.0 pushed with its commit, and release-1.0, pushed alone on a commit the remote already had, ran no hook at all (pre-commit skips a new ref that carries no commits the remote lacks).

Checks: python -m pytest tests/ -q passes against the released 2.18.3 (10 passed); before the pin change, test_pinned_revisions_match_the_released_version failed as expected. mkdocs build --strict passes with SOCIAL_CARDS=false, and every new in-page link resolves to an anchor in the built site. The YAML snippets parse.

🤖 Generated with Claude Code

https://claude.ai/code/session_013rE6bouKaJvsRyKA4tjqCb