feat(bump): let it respect pre-commit reformats when bumping

Fix #502.

Just add `--retry` to `cz bump` and it will attempt to commit twice if the 1st commit fails. Useful if your 1st commit runs a formatter that can for example change the contents of CHANGELOG.md.

Author: yajo

commitizen/cli.py

@@ -165,6 +165,12 @@
                         "default": False,
                         "help": "Output changelog to the stdout",
                     },
+                    {
+                        "name": ["--retry"],
+                        "action": "store_true",
+                        "default": False,
+                        "help": "retry commit if it fails the 1st time",
+                    },
                 ],
             },
             {

commitizen/commands/bump.py

@@ -1,3 +1,4 @@
+from logging import getLogger
 from typing import List, Optional
 
 import questionary
@@ -18,6 +19,8 @@
     NoVersionSpecifiedError,
 )
 
+logger = getLogger("commitizen")
+
 
 class Bump:
     """Show prompt for the user to create a guided commit."""
@@ -49,6 +52,7 @@ def __init__(self, config: BaseConfig, arguments: dict):
         self.changelog_to_stdout = arguments["changelog_to_stdout"]
         self.no_verify = arguments["no_verify"]
         self.check_consistency = arguments["check_consistency"]
+        self.retry = arguments["retry"]
 
     def is_initial_tag(self, current_tag_version: str, is_yes: bool = False) -> bool:
         """Check if reading the whole git tree up to HEAD is needed."""
@@ -209,16 +213,22 @@ def __call__(self):  # noqa: C901
                 },
             )
             changelog_cmd()
-            c = cmd.run(f"git add {changelog_cmd.file_name}")
+            c = cmd.run(f"git add {changelog_cmd.file_name} {' '.join(version_files)}")
 
         self.config.set_key("version", str(new_version))
 
         if is_files_only:
             raise ExpectedExit()
 
         c = git.commit(message, args=self._get_commit_args())
+        if self.retry and c.return_code != 0 and self.changelog:
+            # Maybe pre-commit reformatted some files? Retry once
+            logger.debug("1st git.commit error: %s", c.err)
+            logger.info("1st commit attempt failed; retrying once")
+            cmd.run(f"git add {changelog_cmd.file_name} {' '.join(version_files)}")
+            c = git.commit(message, args=self._get_commit_args())
         if c.return_code != 0:
-            raise BumpCommitFailedError(f'git.commit error: "{c.err.strip()}"')
+            raise BumpCommitFailedError(f'2nd git.commit error: "{c.err.strip()}"')
         c = git.tag(
             new_tag_version,
             annotated=self.bump_settings.get("annotated_tag", False)

tests/test_bump_create_commit_message.py

@@ -1,7 +1,11 @@
+import sys
+from pathlib import Path
+from textwrap import dedent
+
 import pytest
 from packaging.version import Version
 
-from commitizen import bump
+from commitizen import bump, cli, cmd
 
 conversion = [
     (
@@ -20,3 +24,47 @@ def test_create_tag(test_input, expected):
         Version(current_version), Version(new_version), message_template
     )
     assert new_tag == expected
+
+
+@pytest.mark.parametrize("retry", (True, False))
+def test_bump_pre_commit_changelog(tmp_commitizen_project, mocker, freezer, retry):
+    freezer.move_to("2022-04-01")
+    testargs = ["cz", "bump", "--changelog", "--yes"]
+    if retry:
+        testargs.append("--retry")
+    else:
+        pytest.xfail("it will fail because pre-commit will reformat CHANGELOG.md")
+    mocker.patch.object(sys, "argv", testargs)
+    with tmp_commitizen_project.as_cwd():
+        # Configure prettier as a pre-commit hook
+        Path(".pre-commit-config.yaml").write_text(
+            """
+            repos:
+              - repo: https://github.com/pre-commit/mirrors-prettier
+                rev: v2.6.2
+                hooks:
+                - id: prettier
+                  stages: [commit]
+            """
+        )
+        # Prettier inherits editorconfig
+        Path(".editorconfig").write_text(
+            """
+            [*]
+            indent_size = 4
+            """
+        )
+        cmd.run("git add -A")
+        cmd.run("git commit -m 'fix: _test'")
+        cmd.run("pre-commit install")
+        cli.main()
+        # Pre-commit fixed last line adding extra indent and "\" char
+        assert Path("CHANGELOG.md").read_text() == dedent(
+            """\
+            ## 0.1.1 (2022-04-01)
+
+            ### Fix
+
+            -   \\_test
+            """
+        )