feat(bump): add commit filter pattern

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

#2075

Author: schlotter

commitizen/bump.py

@@ -62,6 +62,17 @@ def find_increment(
     return cast("Increment", increment)
 
 
+def filter_commits(commits: list[GitCommit], pattern: str) -> list[GitCommit]:
+    """Filter commits before applying bump-pattern matching.
+
+    This keeps the existing line-by-line ``bump_pattern`` behavior intact while
+    allowing repository-specific configuration to exclude unrelated commits from
+    the bump calculation entirely.
+    """
+    select_pattern = re.compile(pattern)
+    return [commit for commit in commits if select_pattern.match(commit.message)]
+
+
 def update_version_in_files(
     current_version: str,
     new_version: str,

commitizen/commands/bump.py

@@ -6,7 +6,7 @@
 
 import questionary
 
-from commitizen import bump, factory, git, hooks, out
+from commitizen import bump, defaults, factory, git, hooks, out
 from commitizen.changelog_formats import get_changelog_format
 from commitizen.commands.changelog import Changelog
 from commitizen.defaults import Settings
@@ -158,7 +158,18 @@ def _find_increment(self, commits: list[git.GitCommit]) -> Increment | None:
             raise NoPatternMapError(
                 f"'{self.config.settings['name']}' rule does not support bump"
             )
-        return bump.find_increment(commits, regex=bump_pattern, increments_map=bump_map)
+        default_filter_pattern = defaults.DEFAULT_SETTINGS["bump_commit_filter_pattern"]
+        bump_commit_filter_pattern = self.cz.bump_commit_filter_pattern
+        if bump_commit_filter_pattern in (None, default_filter_pattern):
+            bump_commit_filter_pattern = self.config.settings.get(
+                "bump_commit_filter_pattern"
+            )
+        if bump_commit_filter_pattern is None:
+            bump_commit_filter_pattern = default_filter_pattern
+        filtered_commits = bump.filter_commits(commits, bump_commit_filter_pattern)
+        return bump.find_increment(
+            filtered_commits, regex=bump_pattern, increments_map=bump_map
+        )
 
     def _validate_arguments(self, current_version: VersionProtocol) -> None:
         errors: list[str] = []

commitizen/commands/version.py

@@ -4,7 +4,7 @@
 
 from packaging.version import InvalidVersion
 
-from commitizen import bump, factory, git, out
+from commitizen import bump, defaults, factory, git, out
 from commitizen.__version__ import __version__
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
@@ -180,8 +180,17 @@ def _get_next_git_version(
             raise NoPatternMapError(
                 f"'{self.config.settings['name']}' rule does not support bump"
             )
+        default_filter_pattern = defaults.DEFAULT_SETTINGS["bump_commit_filter_pattern"]
+        bump_commit_filter_pattern = self.cz.bump_commit_filter_pattern
+        if bump_commit_filter_pattern in (None, default_filter_pattern):
+            bump_commit_filter_pattern = self.config.settings.get(
+                "bump_commit_filter_pattern"
+            )
+        if bump_commit_filter_pattern is None:
+            bump_commit_filter_pattern = default_filter_pattern
+        filtered_commits = bump.filter_commits(commits, bump_commit_filter_pattern)
         increment = bump.find_increment(
-            commits, regex=bump_pattern, increments_map=bump_map
+            filtered_commits, regex=bump_pattern, increments_map=bump_map
         )
 
         # TODO: Consider adding all the parameters `.bump` supports:

commitizen/cz/base.py

@@ -36,6 +36,7 @@ class ValidationResult(NamedTuple):
 
 
 class BaseCommitizen(metaclass=ABCMeta):
+    bump_commit_filter_pattern: str | None = None
     bump_pattern: str | None = None
     bump_map: dict[str, str] | None = None
     bump_map_major_version_zero: dict[str, str] | None = None

commitizen/cz/conventional_commits/conventional_commits.py

@@ -31,6 +31,7 @@ class ConventionalCommitsAnswers(TypedDict):
 
 
 class ConventionalCommitsCz(BaseCommitizen):
+    bump_commit_filter_pattern = defaults.DEFAULT_SETTINGS["bump_commit_filter_pattern"]
     bump_pattern = defaults.BUMP_PATTERN
     bump_map = defaults.BUMP_MAP
     bump_map_major_version_zero = defaults.BUMP_MAP_MAJOR_VERSION_ZERO

commitizen/cz/customize/customize.py

@@ -44,6 +44,7 @@ def _derive_major_version_zero(
 
 
 class CustomizeCommitsCz(BaseCommitizen):
+    bump_commit_filter_pattern = defaults.DEFAULT_SETTINGS["bump_commit_filter_pattern"]
     bump_pattern = defaults.BUMP_PATTERN
     bump_map = defaults.BUMP_MAP
     bump_map_major_version_zero = defaults.BUMP_MAP_MAJOR_VERSION_ZERO
@@ -57,6 +58,7 @@ def __init__(self, config: BaseConfig) -> None:
         self.custom_settings = self.config.settings["customize"]
 
         for attr_name in [
+            "bump_commit_filter_pattern",
             "bump_pattern",
             "bump_map",
             "bump_map_major_version_zero",

commitizen/defaults.py

@@ -12,6 +12,7 @@
 
 
 class CzSettings(TypedDict, total=False):
+    bump_commit_filter_pattern: str
     bump_pattern: str
     bump_map: OrderedDict[str, str]
     bump_map_major_version_zero: OrderedDict[str, str]
@@ -34,6 +35,7 @@ class Settings(TypedDict, total=False):
     allowed_prefixes: list[str]
     always_signoff: bool
     annotated_tag: bool
+    bump_commit_filter_pattern: str
     bump_message: str | None
     change_type_map: dict[str, str]
     changelog_file: str
@@ -88,6 +90,7 @@ class Settings(TypedDict, total=False):
     "tag_format": "$version",  # example v$version
     "legacy_tag_formats": [],
     "ignored_tag_formats": [],
+    "bump_commit_filter_pattern": r".*",
     "bump_message": None,  # bumped v$current_version to $new_version
     "retry_after_failure": False,
     "allow_abort": False,

docs/config/bump.md

@@ -11,6 +11,22 @@ When set to `true`, `cz bump` is equivalent to `cz bump --annotated-tag`.
 annotated_tag = true
 ```
 
+## `bump_commit_filter_pattern`
+
+- Type: `str`
+- Default: `".*"`
+
+Regular expression used to decide which commits `cz bump` should consider
+before applying the commit rule's `bump_pattern`.
+
+This is useful in monorepos where a component should ignore commits that belong
+to other applications or packages.
+
+```toml title="pyproject.toml"
+[tool.commitizen]
+bump_commit_filter_pattern = "^(feat|fix)\\(library-b\\)(!)?:"
+```
+
 ## `bump_message`
 
 Template used to specify the commit message generated when bumping.

docs/config/configuration_file.md

@@ -68,6 +68,7 @@ All formats support the same configuration options. Choose the format that best
     update_changelog_on_bump = true
     changelog_file = "CHANGELOG.md"
     changelog_incremental = false
+    bump_commit_filter_pattern = ".*"
     bump_message = "bump: version $current_version → $new_version"
     gpg_sign = false
     annotated_tag = false
@@ -126,6 +127,7 @@ All formats support the same configuration options. Choose the format that best
         "update_changelog_on_bump": true,
         "changelog_file": "CHANGELOG.md",
         "changelog_incremental": false,
+        "bump_commit_filter_pattern": ".*",
         "bump_message": "bump: version $current_version → $new_version",
         "gpg_sign": false,
         "annotated_tag": false,
@@ -182,6 +184,7 @@ All formats support the same configuration options. Choose the format that best
       update_changelog_on_bump: true
       changelog_file: CHANGELOG.md
       changelog_incremental: false
+      bump_commit_filter_pattern: ".*"
       bump_message: "bump: version $current_version → $new_version"
       gpg_sign: false
       annotated_tag: false
@@ -235,7 +238,7 @@ Key configuration categories include:
 - **Version Management**: `version`, `version_provider`, `version_scheme`, `version_files`
 - **Tagging**: `tag_format`, `legacy_tag_formats`, `ignored_tag_formats`, `gpg_sign`, `annotated_tag`
 - **Changelog**: `changelog_file`, `changelog_format`, `changelog_incremental`, `update_changelog_on_bump`
-- **Bumping**: `bump_message`, `major_version_zero`, `prerelease_offset`, `pre_bump_hooks`, `post_bump_hooks`
+- **Bumping**: `bump_commit_filter_pattern`, `bump_message`, `major_version_zero`, `prerelease_offset`, `pre_bump_hooks`, `post_bump_hooks`
 - **Commit Validation**: `allowed_prefixes`, `message_length_limit`, `allow_abort`, `retry_after_failure`
 - **Customization**: `customize`, `style`, `use_shortcuts`, `template`, `extras`
 

docs/tutorials/monorepo_guidance.md

@@ -34,6 +34,7 @@ Here is a step-by-step example using two libraries, `library-b` and `library-z`:
     version = "0.0.0"
     tag_format = "${version}-library-b" # the component name can be a prefix or suffix with or without a separator
     ignored_tag_formats = ["${version}-library-*"] # Avoid noise from other tags
+    bump_commit_filter_pattern = "^(feat|fix)\\(library-b\\)(!)?:"
     update_changelog_on_bump = true
     ```
 
@@ -44,6 +45,7 @@ Here is a step-by-step example using two libraries, `library-b` and `library-z`:
     version = "0.0.0"
     tag_format = "${version}-library-z"
     ignored_tag_formats = ["${version}-library-*"] # Avoid noise from other tags
+    bump_commit_filter_pattern = "^(feat|fix)\\(library-z\\)(!)?:"
     update_changelog_on_bump = true
     ```
 
@@ -55,7 +57,7 @@ Here is a step-by-step example using two libraries, `library-b` and `library-z`:
     ```
 
 
-## Changelog per component
+## Bump and changelog per component
 
 To filter the correct commits for each component, you'll need to define a strategy.
 
@@ -70,8 +72,9 @@ For example:
 
 ### Example with scope in conventional commits
 
-In this example, we want `library-b`'s changelog to only include commits that use the `library-b` scope.
-To achieve this, we configure Commitizen to match only commit messages with that scope.
+In this example, we want `library-b`'s bump calculation and changelog to only
+include commits that use the `library-b` scope. To achieve this, we configure
+Commitizen to match only commit messages with that scope.
 
 Here is an example configuration for `library-b`: