1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
# Automatically check message before commit
## About
To automatically check a commit message prior to committing, you can use a [git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
## How to
There are two common methods for installing the hooks:
### Method 1: Add a git hook through [pre-commit](https://pre-commit.com/)
- Step 1: Install [pre-commit](https://pre-commit.com/)
```sh
python -m pip install pre-commit
```
- Step 2: Create `.pre-commit-config.yaml` in your root directory with the following content
```yaml
---
repos:
- repo: https://github.com/commitizen-tools/commitizen
rev: v1.17.0
hooks:
- id: commitizen
stages: [commit-msg]
```
- Step 3: Install the configuration into the git hook through `pre-commit`
```bash
pre-commit install --hook-type commit-msg
```
### Method 2: Manually add a git hook
The command might be included inside a Git hook (inside `.git/hooks/` at the root of the project).
The selected hook might be the file called commit-msg.
This example shows how to use the check command inside commit-msg.
At the root of the project:
```bash
cd .git/hooks
touch commit-msg
chmod +x commit-msg
```
Open the file and edit it:
```sh
#!/bin/bash
MSG_FILE=$1
cz check --allow-abort --commit-msg-file $MSG_FILE
```
Where `$1` is the name of the temporary file that contains the current commit message. To be more explicit, the previous variable is stored in another variable called `$MSG_FILE`, for didactic purposes.
The `--commit-msg-file` flag is required, not optional.
Each time you create a commit, this hook will automatically analyze it.
If the commit message is invalid, it will be rejected.
The commit should follow the given committing rules; otherwise, it won't be accepted.
|
