Skip to content

Commit 4ad1049

Browse files
bearomorphismbearomorphism
committed
Deploying to gh-pages from @ 667de74 🚀
1 parent a36960e commit 4ad1049

13 files changed

Lines changed: 65 additions & 65 deletions

File tree

‎customization/config_file/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2388,7 +2388,7 @@ <h2 id="configuration-file-options">Configuration File Options<a class="headerli
23882388
<td><code>bump_map</code></td>
23892389
<td><code>dict</code></td>
23902390
<td><code>None</code></td>
2391-
<td>(OPTIONAL) Dictionary mapping the extracted information to a <code>SemVer</code> increment type (<code>MAJOR</code>, <code>MINOR</code>, <code>PATCH</code>)</td>
2391+
<td>(OPTIONAL) Dictionary mapping the extracted information to a <code>SemVer</code> increment type (<code>MAJOR</code>, <code>MINOR</code>, <code>PATCH</code>). In JSON and YAML configs, <code>null</code> keeps a matched rule from bumping the version.</td>
23922392
</tr>
23932393
<tr>
23942394
<td><code>bump_pattern</code></td>
@@ -2563,7 +2563,7 @@ <h4 id="use_shortcuts-with-cz_customize"><code>use_shortcuts</code> with <code>c
25632563
<span class="md-icon" title="Last update">
25642564
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
25652565
</span>
2566-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="March 14, 2026 07:37:49 UTC">March 14, 2026</span>
2566+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 3, 2026 09:14:45 UTC">October 3, 2026</span>
25672567
</span>
25682568

25692569

‎customization/config_file/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ commitizen:
161161
| `schema_pattern` | `str` | `""` | (OPTIONAL) The regular expression used to do commit message validation. Used by `cz check`. |
162162
| `info_path` | `str` | `""` | (OPTIONAL) The path to the file that contains explanation of the commit rules. Used by `cz info`. If not provided `cz info`, will load `info` instead. |
163163
| `info` | `str` | `""` | (OPTIONAL) Explanation of the commit rules. Used by `cz info`. |
164-
| `bump_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) |
164+
| `bump_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`). In JSON and YAML configs, `null` keeps a matched rule from bumping the version. |
165165
| `bump_pattern` | `str` | `None` | (OPTIONAL) Regex to extract information from commit (subject and body) |
166166
| `change_type_order` | `str` | `None` | (OPTIONAL) List of strings used to order the Changelog. All other types will be sorted alphabetically. Default is `["BREAKING CHANGE", "Feat", "Fix", "Refactor", "Perf"]` |
167167
| `commit_parser` | `str` | `None` | (OPTIONAL) Regex to extract information used in creating changelog. [See more](https://commitizen-tools.github.io/commitizen/commands/changelog/) |

‎customization/python_class/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2371,7 +2371,7 @@ <h2 id="custom-bump-rules">Custom bump rules<a class="headerlink" href="#custom-
23712371
<td><code>bump_map</code></td>
23722372
<td><code>dict</code></td>
23732373
<td><code>None</code></td>
2374-
<td>Dictionary mapping the extracted information to a <code>SemVer</code> increment type (<code>MAJOR</code>, <code>MINOR</code>, <code>PATCH</code>)</td>
2374+
<td>Dictionary mapping the extracted information to a <code>SemVer</code> increment type (<code>MAJOR</code>, <code>MINOR</code>, <code>PATCH</code>). Use <code>None</code> when a matched rule should not bump the version.</td>
23752375
</tr>
23762376
</tbody>
23772377
</table>
@@ -2706,7 +2706,7 @@ <h3 id="example">Example<a class="headerlink" href="#example" title="Permanent l
27062706
<span class="md-icon" title="Last update">
27072707
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
27082708
</span>
2709-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="September 17, 2026 19:44:31 UTC">September 17, 2026</span>
2709+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 3, 2026 09:14:45 UTC">October 3, 2026</span>
27102710
</span>
27112711

27122712

‎customization/python_class/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ And that's it. You can install it without uploading to PyPI by simply doing `pip
101101

102102
You need to define 2 parameters inside your custom `BaseCommitizen`.
103103

104-
| Parameter | Type | Default | Description |
105-
| -------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------- |
106-
| `bump_pattern` | `str` | `None` | Regex to extract information from commit (subject and body) |
107-
| `bump_map` | `dict` | `None` | Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) |
104+
| Parameter | Type | Default | Description |
105+
| -------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
106+
| `bump_pattern` | `str` | `None` | Regex to extract information from commit (subject and body) |
107+
| `bump_map` | `dict` | `None` | Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`). Use `None` when a matched rule should not bump the version. |
108108

109109
Let's see an example.
110110

‎images/cli_interactive/bump.gif‎

325 Bytes
Loading

‎images/cli_interactive/commit.gif‎

2.24 KB
Loading

‎images/cli_interactive/init.gif‎

371 Bytes
Loading

‎images/cli_interactive/shortcut_custom.gif‎

242 Bytes
Loading

‎images/cli_interactive/shortcut_default.gif‎

1.3 KB
Loading

‎llms-full.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2823,7 +2823,7 @@ commitizen:
28232823
| `schema_pattern` | `str` | `""` | (OPTIONAL) The regular expression used to do commit message validation. Used by `cz check`. |
28242824
| `info_path` | `str` | `""` | (OPTIONAL) The path to the file that contains explanation of the commit rules. Used by `cz info`. If not provided `cz info`, will load `info` instead. |
28252825
| `info` | `str` | `""` | (OPTIONAL) Explanation of the commit rules. Used by `cz info`. |
2826-
| `bump_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) |
2826+
| `bump_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`). In JSON and YAML configs, `null` keeps a matched rule from bumping the version. |
28272827
| `bump_pattern` | `str` | `None` | (OPTIONAL) Regex to extract information from commit (subject and body) |
28282828
| `change_type_order` | `str` | `None` | (OPTIONAL) List of strings used to order the Changelog. All other types will be sorted alphabetically. Default is `["BREAKING CHANGE", "Feat", "Fix", "Refactor", "Perf"]` |
28292829
| `commit_parser` | `str` | `None` | (OPTIONAL) Regex to extract information used in creating changelog. [See more](https://commitizen-tools.github.io/commitizen/commands/changelog/) |
@@ -2994,10 +2994,10 @@ And that's it. You can install it without uploading to PyPI by simply doing `pip
29942994

29952995
You need to define 2 parameters inside your custom `BaseCommitizen`.
29962996

2997-
| Parameter | Type | Default | Description |
2998-
| -------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------- |
2999-
| `bump_pattern` | `str` | `None` | Regex to extract information from commit (subject and body) |
3000-
| `bump_map` | `dict` | `None` | Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) |
2997+
| Parameter | Type | Default | Description |
2998+
| -------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2999+
| `bump_pattern` | `str` | `None` | Regex to extract information from commit (subject and body) |
3000+
| `bump_map` | `dict` | `None` | Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`). Use `None` when a matched rule should not bump the version. |
30013001

30023002
Let's see an example.
30033003

0 commit comments

Comments
 (0)