Skip to content

Commit 221a8d7

Browse files
committed
docs(changelog): document usage of message_hook
1 parent e8b7ab1 commit 221a8d7

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/customization.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,12 +137,12 @@ cz -n cz_strange bump
137137
The changelog generator should just work in a very basic manner without touching anything.
138138
You can customize it of course, and this are the variables you need to add to your custom `BaseCommitizen`.
139139

140-
| Parameter | Type | Required | Description |
141-
| ------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
142-
| `commit_parser` | `str` | NO | Regex which should provide the variables explained in the [changelog description][changelog-des] |
143-
| `changelog_pattern` | `str` | NO | Regex to validate the commits, this is useful to skip commits that don't meet your rulling standards like a Merge. Usually the same as bump_pattern |
144-
| `change_type_map` | `dict` | NO | Convert the title of the change type that will appear in the changelog, if a value is not found, the original will be provided |
145-
140+
| Parameter | Type | Required | Description |
141+
| ------------------- | --------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
142+
| `commit_parser` | `str` | NO | Regex which should provide the variables explained in the [changelog description][changelog-des] |
143+
| `changelog_pattern` | `str` | NO | Regex to validate the commits, this is useful to skip commits that don't meet your rulling standards like a Merge. Usually the same as bump_pattern |
144+
| `change_type_map` | `dict` | NO | Convert the title of the change type that will appear in the changelog, if a value is not found, the original will be provided |
145+
| `message_hook` | `method: (dict, git.GitCommit) -> dict` | NO | Customize with extra information your message output, like adding links, this function is executed per parsed commit. |
146146

147147
[changelog-des]: ./changelog.md#description
148148

0 commit comments

Comments
 (0)