Skip to content

fix: clean up pre-commit config and hook #297

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 1 commit into from
Oct 10, 2025
Merged

fix: clean up pre-commit config and hook #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 1 addition & 6 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ ci:
autoupdate_schedule: quarterly

# https://pre-commit.com/
# commit-msg is used by hook id: check-message
default_install_hook_types: [pre-commit, commit-msg]
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
Expand Down Expand Up @@ -36,9 +34,6 @@ repos:
rev: v0.10.2
hooks:
- id: check-message
# - id: check-branch # uncomment if you need.
- id: check-branch # uncomment if you need.
- id: check-author-name # uncomment if you need.
- id: check-author-email # uncomment if you need.
Comment on lines 36 to 39

@coderabbitai coderabbitai Bot Oct 10, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Restore commit-msg installation for check-message.

Dropping default_install_hook_types: [pre-commit, commit-msg] (and the commit-msg stage) means pre-commit install no longer sets up the commit-msg hook, so check-message never runs. The commit message validator silently stops working—a regression. Please restore commit-msg installation (either via default_install_hook_types or per-hook stages: [commit-msg], plus the matching change in .pre-commit-hooks.yaml) so the check keeps executing.

 repos:
+-   default_install_hook_types: [pre-commit, commit-msg]
     -   repo: https://github.com/commit-check/commit-check
         rev: v0.10.2
         hooks:
         -   id: check-message
+            stages: [commit-msg]

Based on learnings

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
.pre-commit-config.yaml lines 36-39: the commit-msg hook installation was
removed so the check-message hook never runs; restore commit-msg installation by
either adding back default_install_hook_types: [pre-commit, commit-msg] to the
file or by adding stages: [commit-msg] to the check-message hook entry and also
ensure the corresponding .pre-commit-hooks.yaml lists commit-msg in that hook's
stages; update both files accordingly so pre-commit install sets up the
commit-msg hook and the check-message hook executes on commit messages.

# - id: check-commit-signoff # uncomment if you need.
# - id: check-merge-base # requires download all git history
# - id: check-imperative # uncomment if you need.
1 change: 0 additions & 1 deletion .pre-commit-hooks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
args: [--message]
pass_filenames: true
language: python
stages: [commit-msg]
- id: check-branch
name: check branch name
description: ensures branch name to match regex
Expand Down
8 changes: 4 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ Version 2.0.0 is a major release featuring a new configuration format, a moderni

**✨ Highlights**

* TOML Configuration — Replaces ``.commit-check.yml`` with ``cchk.toml`` or ``commit-check.toml`` for clearer, more consistent syntax.
* Simplified CLI & Hooks — Legacy pre-commit hooks and options removed for a cleaner interface.
* New Validation Engine — Redesigned for better flexibility, performance, and maintainability.
* **TOML Configuration** — Replaces ``.commit-check.yml`` with ``cchk.toml`` or ``commit-check.toml`` for clearer, more consistent syntax.
* **Simplified CLI & Hooks** — Legacy pre-commit hooks and options removed to deliver a cleaner, more streamlined interface.
* **New Validation Engine** — Fully redesigned for greater flexibility, performance, and maintainability.

For the full list of updates and improvements, see the `What's New <https://commit-check.github.io/commit-check/what-is-new.html>`_ page.
For the full list of updates and improvements, visit the `What's New <https://commit-check.github.io/commit-check/what-is-new.html>`_ page.

Configuration
-------------
Expand Down
Loading