feat(bump): implements ignore_bump_* by namwoam · Pull Request #1853 · commitizen-tools/commitizen

namwoam · 2026-02-07T13:12:34Z

Description

This PR will let user select commits that shouldn't be bump version. Solve #1772

Checklist

I have read the contributing guidelines

Was generative AI tooling used to co-author this PR?

Yes (please specify the tool below)

Code Changes

Add test cases to all the changes you introduce
Run uv run poe all locally to ensure this change passes linter check and tests
Manually test the changes:
- Verify the feature/bug fix works as expected in real-world scenarios
- Test edge cases and error conditions
- Ensure backward compatibility is maintained
- Document any manual testing steps performed
Update the documentation for the changes

Documentation Changes

Run uv run poe doc locally to ensure the documentation pages renders correctly
Check and fix any broken links (internal or external)

Expected Behavior

Steps to Test This Pull Request

Steps to reproduce the behavior:

Add a test file test.txt
commit "feat: this should not be bumped"
suppose got the following git log:

commit e302cb4f2c626099b4a9c8cf881b0bb5906b7356
Author: andre.liang <namwoam@gmail.com>
Date:   Sat Feb 7 21:33:10 2026 +0800

    feat: add a new test file, this should not be bumped

configure either ignore_bump_rev_list=["e302cb4f2c626099b4a9c8cf881b0bb5906b7356"] or ignore_bump_author_list=["andre.liang"] to ignore this commit from version bump calculation.
run cz bump will produce:

[NO_COMMITS_TO_BUMP]
The commits found are not eligible to be bumped

Additional Context

…crement

… Settings

codecov · 2026-02-07T13:13:10Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.00%. Comparing base (573ffda) to head (486d9a0).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1853   +/-   ##
=======================================
  Coverage   97.99%   98.00%           
=======================================
  Files          60       60           
  Lines        2692     2702   +10     
=======================================
+ Hits         2638     2648   +10     
  Misses         54       54

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

namwoam · 2026-02-07T14:11:43Z

Hello @bearomorphism , this PR is ready. Please help me rename this PR to feat: implements ignore_bump_*, I don't have the permission to do that.

bearomorphism · 2026-02-08T01:57:39Z

I remember the author can edit the PR title and description. That is strange

Copilot

Pull request overview

Adds support for excluding specific commits from version bump detection, allowing users to avoid bumps triggered by selected revisions or authors (addresses issue #1772).

Changes:

Extend bump increment detection to skip commits by revision (ignore_bump_rev_list) or author (ignore_bump_author_list).
Wire new config settings through the cz bump command into the increment finder.
Add tests and user documentation for the new configuration options.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`commitizen/bump.py`	Adds ignore-by-rev/author filtering while scanning commits for bump keywords.
`commitizen/commands/bump.py`	Reads ignore lists from config and passes them into `bump.find_increment`.
`commitizen/defaults.py`	Extends `Settings` typing to include the new config keys.
`tests/test_bump_find_increment.py`	Adds unit tests covering rev-based and author-based ignore behavior.
`docs/config/bump.md`	Documents the new `ignore_bump_*` configuration options with examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-08T04:51:26Z

commitizen/bump.py

+
+        if ignore_bump_author_list and commit.author in ignore_bump_author_list:
+            logger.debug(
+                f"Skipping commit {commit.rev} as its author '{commit.author}' is in ignore_bump_author_list"


The debug log message on this line exceeds the configured formatter/linter max line length (88 in pyproject.toml). Please wrap/reformat the string (or split it across lines) to avoid CI formatting/lint failures.

Suggested change

f"Skipping commit {commit.rev} as its author '{commit.author}' is in ignore_bump_author_list"

"Skipping commit %s as its author '%s' is in ignore_bump_author_list",

commit.rev,

commit.author,

Need to check what logger actually does

Copilot · 2026-02-08T04:51:26Z

docs/config/bump.md

+Here’s a clearer, more consistent rewrite with tightened wording, corrected descriptions, and parallel structure between the two options.
+
+## `ignore_bump_rev_list`
+
+- Type: `list`
+- Default: `[]`


This sentence reads like meta commentary about the doc rewrite rather than user-facing documentation. Please remove it (or replace it with content that describes the settings) so the config page stays focused and professional.

Suggested change

Here’s a clearer, more consistent rewrite with tightened wording, corrected descriptions, and parallel structure between the two options.

## `ignore_bump_rev_list`

- Type: `list`

- Default: `[]`

## `ignore_bump_rev_list`

- Type: `list`

- Default: `[]`

- Type: `list`

- Default: `[]`

bearomorphism · 2026-02-08T04:53:06Z

docs/config/bump.md


 See [`--version-scheme`](../commands/bump.md#-version-scheme).
+
+Here’s a clearer, more consistent rewrite with tightened wording, corrected descriptions, and parallel structure between the two options.


bearomorphism · 2026-02-08T08:02:58Z

commitizen/bump.py

+    ignore_bump_rev_list: list[str] | None = None,
+    ignore_bump_author_list: list[str] | None = None,


do we need these new parameters to be optional?

woile · 2026-02-08T09:31:32Z

I don't get this PR, it doesn't have any test reproducing the issue mentioned in the original ticket.
How are authors related to this?

namwoam added 2 commits February 7, 2026 21:11

feat: add ignore_bump_sha_list and ignore_bump_author_list to find_in…

d82dd5a

…crement

feat(config): add ignore_bump_sha_list and ignore_bump_author_list to…

0488175

… Settings

namwoam requested review from Lee-W, noirbizarre and woile as code owners February 7, 2026 13:12

github-actions bot added the pr-status: wait-for-review label Feb 7, 2026

namwoam marked this pull request as draft February 7, 2026 13:12

namwoam added 3 commits February 7, 2026 21:16

fix: fix errors when merging

b753dd5

fix: align naming convension

49c7e2d

chore: update document

486d9a0

namwoam marked this pull request as ready for review February 7, 2026 14:09

namwoam changed the title ~~[WIP] Improve bump pattern~~ feat: implements ignore_bump_* Feb 8, 2026

namwoam changed the title feat: implements ignore_bump_* feat(bump): implements ignore_bump_* Feb 8, 2026

bearomorphism requested a review from Copilot February 8, 2026 04:48

Copilot started reviewing on behalf of bearomorphism February 8, 2026 04:48 View session

Copilot AI reviewed Feb 8, 2026

View reviewed changes

bearomorphism reviewed Feb 8, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(bump): implements ignore_bump_*#1853

feat(bump): implements ignore_bump_*#1853
namwoam wants to merge 5 commits intocommitizen-tools:masterfrom
namwoam:improve-bump-pattern

namwoam commented Feb 7, 2026 •

edited

Loading

Uh oh!

codecov bot commented Feb 7, 2026 •

edited

Loading

Uh oh!

namwoam commented Feb 7, 2026

Uh oh!

bearomorphism commented Feb 8, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

bearomorphism Feb 8, 2026

Uh oh!

Copilot AI Feb 8, 2026

Uh oh!

bearomorphism Feb 8, 2026

Uh oh!

bearomorphism Feb 8, 2026

Uh oh!

woile commented Feb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-                f"Skipping commit {commit.rev} as its author '{commit.author}' is in ignore_bump_author_list"
+                "Skipping commit %s as its author '%s' is in ignore_bump_author_list",
+                commit.rev,
+                commit.author,


		See [`--version-scheme`](../commands/bump.md#-version-scheme).

		Here’s a clearer, more consistent rewrite with tightened wording, corrected descriptions, and parallel structure between the two options.

		ignore_bump_rev_list: list[str] \| None = None,
		ignore_bump_author_list: list[str] \| None = None,

Uh oh!

Conversation

namwoam commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Was generative AI tooling used to co-author this PR?

Code Changes

Documentation Changes

Expected Behavior

Steps to Test This Pull Request

Additional Context

Uh oh!

codecov bot commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

namwoam commented Feb 7, 2026

Uh oh!

bearomorphism commented Feb 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

bearomorphism Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

bearomorphism Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

bearomorphism Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

woile commented Feb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

namwoam commented Feb 7, 2026 •

edited

Loading

codecov bot commented Feb 7, 2026 •

edited

Loading