Merge branch 'master' into feature/author-and-sha1

Author: woile

.pre-commit-config.yaml

@@ -46,7 +46,7 @@ repos:
         exclude: "poetry.lock"
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v3.18.0 # automatically updated by Commitizen
+    rev: v3.18.1 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch

CHANGELOG.md

@@ -1,4 +1,10 @@
 
+## v3.18.1 (2024-03-11)
+
+### Fix
+
+- **changelog**: changelog hook was not called on dry run
+
 ## v3.18.0 (2024-03-07)
 
 ### Feat

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "3.18.0"
+__version__ = "3.18.1"

commitizen/commands/changelog.py

@@ -132,6 +132,11 @@ def write_changelog(
 
             if changelog_hook:
                 changelog_out = changelog_hook(changelog_out, partial_changelog)
+
+            if self.dry_run:
+                out.write(changelog_out)
+                raise DryRunExit()
+
             changelog_file.write(changelog_out)
 
     def export_template(self):
@@ -216,10 +221,6 @@ def __call__(self):
         )
         changelog_out = changelog_out.lstrip("\n")
 
-        if self.dry_run:
-            out.write(changelog_out)
-            raise DryRunExit()
-
         lines = []
         if self.incremental and os.path.isfile(self.file_name):
             with open(self.file_name, encoding=self.encoding) as changelog_file:

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "3.18.0"
+version = "3.18.1"
 tag_format = "v$version"
 version_files = [
   "pyproject.toml:version",
@@ -9,7 +9,7 @@ version_files = [
 
 [tool.poetry]
 name = "commitizen"
-version = "3.18.0"
+version = "3.18.1"
 description = "Python commitizen client tool"
 authors = ["Santiago Fraire <santiwilly@gmail.com>"]
 license = "MIT"

tests/commands/test_changelog_command.py

@@ -12,6 +12,7 @@
 from commitizen import __file__ as commitizen_init
 from commitizen import cli, git
 from commitizen.commands.changelog import Changelog
+from commitizen.config.base_config import BaseConfig
 from commitizen.cz.base import BaseCommitizen
 from commitizen.exceptions import (
     DryRunExit,
@@ -275,20 +276,24 @@ def test_changelog_incremental_keep_a_changelog_sample(
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
-def test_changelog_hook(mocker: MockFixture, config):
+@pytest.mark.parametrize("dry_run", [True, False])
+def test_changelog_hook(mocker: MockFixture, config: BaseConfig, dry_run: bool):
     changelog_hook_mock = mocker.Mock()
     changelog_hook_mock.return_value = "cool changelog hook"
 
     create_file_and_commit("feat: new file")
     create_file_and_commit("refactor: is in changelog")
     create_file_and_commit("Merge into master")
 
-    config.settings["change_type_order"] = ["Refactor", "Feat"]
+    config.settings["change_type_order"] = ["Refactor", "Feat"]  # type: ignore[typeddict-unknown-key]
     changelog = Changelog(
-        config, {"unreleased_version": None, "incremental": True, "dry_run": False}
+        config, {"unreleased_version": None, "incremental": True, "dry_run": dry_run}
     )
     mocker.patch.object(changelog.cz, "changelog_hook", changelog_hook_mock)
-    changelog()
+    try:
+        changelog()
+    except DryRunExit:
+        pass
     full_changelog = (
         "## Unreleased\n\n### Refactor\n\n- is in changelog\n\n### Feat\n\n- new file\n"
     )