Skip to content

docs: document additional_dependencies for pre-commit plugin hooks #2095

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
woile merged 1 commit into from
Sep 24, 2026
+13 −0
Merged

docs: document additional_dependencies for pre-commit plugin hooks #2095

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
13 changes: 13 additions & 0 deletions docs/tutorials/auto_check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,19 @@ repos:
!!! tip "Using the latest version"
Replace `v4.10.0` with the latest commitizen version. You can find the latest version on [GitHub releases](https://github.com/commitizen-tools/commitizen/releases) or use a specific commit SHA for pinning to an exact version.

!!! tip "Using a third-party commitizen plugin"
If your project uses a [third-party plugin](../third-party-plugins/about.md) (for example, a custom `name` such as `cz_gitmoji` from [cz-conventional-gitmoji](../third-party-plugins/cz-conventional-gitmoji.md)), add the plugin package to `additional_dependencies`. `prek`/`pre-commit` installs each hook in its own isolated environment, so the plugin is not available unless it is listed explicitly, and the hook fails with an error such as `The committer has not been found in the system`:

```yaml
repos:
- repo: https://github.com/commitizen-tools/commitizen
rev: v4.10.0 # Use the latest version or a specific version
hooks:
- id: commitizen
stages: [commit-msg]
additional_dependencies: ["cz-conventional-gitmoji"]
```

#### Step 3: Install the hook

Install the configuration into Git's hook system:
Expand Down
Loading