feat(conventional_commits): allow exclamation in title on BC

Add a configuration (disable by default) to allow exclamation in
commit title to ease identify BC simple git log parsing.

Signed-off-by: Sebastien Fusilier <[email protected]>

Author: bastien31

commitizen/cz/conventional_commits/conventional_commits.py

@@ -154,11 +154,21 @@ def message(self, answers: ConventionalCommitsAnswers) -> str:  # type: ignore[o
         footer = answers["footer"]
         is_breaking_change = answers["is_breaking_change"]
 
+        # Check if breaking change exclamation in title is enabled
+        breaking_change_exclamation_in_title = self.config.settings.get(
+            "breaking_change_exclamation_in_title", False
+        )
+
         if scope:
             scope = f"({scope})"
         if body:
             body = f"\n\n{body}"
         if is_breaking_change:
+            if breaking_change_exclamation_in_title:
+                if scope:
+                    scope = f"{scope}!"
+                else:
+                    prefix = f"{prefix}!"
             footer = f"BREAKING CHANGE: {footer}"
         if footer:
             footer = f"\n\n{footer}"

commitizen/defaults.py

@@ -61,6 +61,7 @@ class Settings(TypedDict, total=False):
     version_scheme: str | None
     version_type: str | None
     version: str | None
+    breaking_change_exclamation_in_title: bool
 
 
 CONFIG_FILES: list[str] = [
@@ -108,6 +109,7 @@ class Settings(TypedDict, total=False):
     "always_signoff": False,
     "template": None,  # default provided by plugin
     "extras": {},
+    "breaking_change_exclamation_in_title": False,
 }
 
 MAJOR = "MAJOR"

docs/config.md

@@ -96,6 +96,15 @@ Use annotated tags instead of lightweight tags. [See difference][annotated-tags-
 
 Create custom commit message. Useful to skip CI. [Read more][bump_message]
 
+### `breaking_change_exclamation_in_title`
+
+Type: `bool`
+
+Default: `false`
+
+When true, breaking changes will be indicated by an exclamation mark in the commit title (e.g., `feat!: breaking change`).
+When false, breaking changes will be indicated by `BREAKING CHANGE:` in the footer. [Read more][breaking-change-exclamation]
+
 ### `retry_after_failure`
 
 - Type: `bool`

docs/tutorials/writing_commits.md

@@ -13,6 +13,10 @@ add to your commit body the following `BREAKING CHANGE`.
 Using these three keywords will allow the proper identification of the semantic version.
 Of course, there are other keywords, but I'll leave it to the reader to explore them.
 
+Note: You can also indicate breaking changes by adding an exclamation mark in the commit title
+(e.g., `feat!: breaking change`) by setting the `breaking_change_exclamation_in_title`
+configuration option to `true`. [Read more][breaking-change-config]
+
 ## Writing commits
 
 Now to the important part: when writing commits, it's important to think about:
@@ -44,3 +48,4 @@ Emojis may be added as well (e.g., see [cz-emoji][cz_emoji]), which requires the
 [conventional_commits]: https://www.conventionalcommits.org
 [cz_emoji]: https://commitizen-tools.github.io/commitizen/third-party-commitizen/#cz-emoji
 [configuration]: ../config.md#encoding
+[breaking-change-config]: ../config.md#breaking_change_exclamation_in_title

tests/test_conf.py

@@ -95,6 +95,7 @@
     "always_signoff": False,
     "template": None,
     "extras": {},
+    "breaking_change_exclamation_in_title": False,
 }
 
 _new_settings: dict[str, Any] = {
@@ -126,6 +127,7 @@
     "always_signoff": False,
     "template": None,
     "extras": {},
+    "breaking_change_exclamation_in_title": False,
 }
 
 

tests/test_cz_conventional_commits.py

@@ -105,6 +105,55 @@ def test_breaking_change_in_footer(config):
     )
 
 
+@pytest.mark.parametrize(
+    "scope,breaking_change_exclamation_in_title,expected_message",
+    [
+        # Test with scope and breaking_change_exclamation_in_title enabled
+        (
+            "users",
+            True,
+            "feat(users)!: email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users",
+        ),
+        # Test without scope and breaking_change_exclamation_in_title enabled
+        (
+            "",
+            True,
+            "feat!: email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users",
+        ),
+        # Test with scope and breaking_change_exclamation_in_title disabled
+        (
+            "users",
+            False,
+            "feat(users): email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users",
+        ),
+        # Test without scope and breaking_change_exclamation_in_title disabled
+        (
+            "",
+            False,
+            "feat: email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users",
+        ),
+    ],
+)
+def test_breaking_change_message_formats(
+    config, scope, breaking_change_exclamation_in_title, expected_message
+):
+    # Set the breaking_change_exclamation_in_title setting
+    config.settings["breaking_change_exclamation_in_title"] = (
+        breaking_change_exclamation_in_title
+    )
+    conventional_commits = ConventionalCommitsCz(config)
+    answers = {
+        "prefix": "feat",
+        "scope": scope,
+        "subject": "email pattern corrected",
+        "is_breaking_change": True,
+        "body": "complete content",
+        "footer": "migrate by renaming user to users",
+    }
+    message = conventional_commits.message(answers)
+    assert message == expected_message
+
+
 def test_example(config):
     """just testing a string is returned. not the content"""
     conventional_commits = ConventionalCommitsCz(config)