feat: add changeup_hide_breaking option

Adds option for hiding breaking changes from commit body in changelog.

BREAKING CHANGE: Breaking changes will now be hidden from the commit body and will only appear in the breaking change section. The behavior can be controlled with the newly added option `changeup_hide_breaking`.

Author: kmnhan

README.md

@@ -39,6 +39,7 @@ The behavior of the plugin can be customized by providing the following options
 | `changeup_repo_base_url`   | The base URL for the repository, for instance `"https://github.com/my/repo"`.                                                                    | `""`    |
 | `changeup_show_hash`       | Whether to add a link to the commit for each entry in the changelog. If `changeup_repo_base_url` is provided, the hash are linked to the commit. | `true`  |
 | `changeup_show_body`       | Whether to include the commit body in the changelog.                                                                                             | `true`  |
+| `changeup_hide_breaking`   | Whether to include the breaking changes section also in the the commit body if `changeup_show_body` is true. This prevents duplicate entries.    | `true`  |
 | `changeup_body_indent`     | The number of spaces to indent the commit body if `changeup_show_body` is set to `true`.                                                         | `2`     |
 | `changeup_link_issues`     | If `true`, tries to convert issue numbers in phrases like `closes #21` to links. Only works if `changeup_repo_base_url` is provided.             | `true`  |
 | `changeup_scope_prefix`    | Prefix for the scope of the change.                                                                                                              | `"**"`  |

src/cz_changeup/cz_changeup.py

@@ -46,6 +46,7 @@ class ChangeupCz(ConventionalCommitsCz):
     repo_base_url: str = conf.settings.get("changeup_repo_base_url", "").strip(" /")
     show_hash: bool = conf.settings.get("changeup_show_hash", True)
     show_body: bool = conf.settings.get("changeup_show_body", True)
+    hide_breaking: bool = conf.settings.get("changeup_hide_breaking", True)
     body_indent: int = conf.settings.get("changeup_body_indent", 2)
 
     link_issues: bool = conf.settings.get("changeup_link_issues", True)
@@ -66,9 +67,13 @@ def changelog_message_builder_hook(
             )
 
         if self.show_body and commit.body:
+            body = str(commit.body)
+            if self.hide_breaking and "BREAKING CHANGE:" in body:
+                body = body.split("BREAKING CHANGE:")[0].strip()
+
             msg += f"\n\n{' ' * self.body_indent}"
             body = ("\n\n" + (" " * self.body_indent)).join(
-                [s.strip() for s in str(commit.body).split("\n") if s]
+                [s.strip() for s in body.split("\n") if s]
             )
             msg += f"{body}"