Skip to content

Commit 486d9a0

Browse files
committed
chore: update document
1 parent 49c7e2d commit 486d9a0

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

docs/config/bump.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,3 +215,57 @@ version_files = [
215215
## `version_scheme`
216216

217217
See [`--version-scheme`](../commands/bump.md#-version-scheme).
218+
219+
Here’s a clearer, more consistent rewrite with tightened wording, corrected descriptions, and parallel structure between the two options.
220+
221+
## `ignore_bump_rev_list`
222+
223+
- Type: `list`
224+
- Default: `[]`
225+
226+
A list of git commit revisions (SHAs) that should be excluded from version bump calculation.
227+
228+
For example, given the following commit:
229+
230+
```text
231+
commit e302cb4f2c626099b4a9c8cf881b0bb5906b7356
232+
Author: example_user <example@gmail.com>
233+
Date: Sat Feb 1 21:00:00 2026 +0800
234+
235+
feat: add a new test file, this should not be bumped
236+
```
237+
238+
Configure `pyproject.toml` as follows:
239+
240+
```toml title="pyproject.toml"
241+
[tool.commitizen]
242+
ignore_bump_rev_list = ["e302cb4f2c626099b4a9c8cf881b0bb5906b7356"]
243+
```
244+
245+
As a result, this commit will be ignored when determining whether a version bump is required.
246+
247+
## `ignore_bump_author_list`
248+
249+
- Type: `list`
250+
- Default: `[]`
251+
252+
A list of commit authors whose commits should be excluded from version bump calculation.
253+
254+
For example, given the following commit:
255+
256+
```text
257+
commit e302cb4f2c626099b4a9c8cf881b0bb5906b7356
258+
Author: example_user <example@gmail.com>
259+
Date: Sat Feb 1 21:00:00 2026 +0800
260+
261+
feat: add a new test file, this should not be bumped
262+
```
263+
264+
Configure `pyproject.toml` as follows:
265+
266+
```toml title="pyproject.toml"
267+
[tool.commitizen]
268+
ignore_bump_author_list = ["example_user"]
269+
```
270+
271+
As a result, any commit authored by `example_user` will be ignored when determining whether a version bump is required.

0 commit comments

Comments
 (0)