feat(changelog): add support for changelog_hook when changelog finishes the generation

Author: woile

commitizen/commands/changelog.py

@@ -65,6 +65,7 @@ def __call__(self):
         changelog_meta: Dict = {}
         change_type_map: Optional[Dict] = self.change_type_map
         message_hook: Optional[Callable] = self.cz.message_hook
+        changelog_hook: Optional[Callable] = self.cz.changelog_hook
 
         if not changelog_pattern or not commit_parser:
             out.error(
@@ -108,10 +109,14 @@ def __call__(self):
                 lines = changelog_file.readlines()
 
         with open(self.file_name, "w") as changelog_file:
+            partial_changelog: Optional[str] = None
             if self.incremental:
                 new_lines = changelog.incremental_build(
                     changelog_out, lines, changelog_meta
                 )
-                changelog_file.writelines(new_lines)
-            else:
-                changelog_file.write(changelog_out)
+                changelog_out = "".join(new_lines)
+                partial_changelog = changelog_out
+
+            if changelog_hook:
+                changelog_out = changelog_hook(changelog_out, partial_changelog)
+            changelog_file.write(changelog_out)

commitizen/cz/base.py

@@ -1,8 +1,9 @@
 from abc import ABCMeta, abstractmethod
-from typing import Callable, List, Optional, Tuple
+from typing import Callable, Dict, List, Optional, Tuple
 
 from prompt_toolkit.styles import Style, merge_styles
 
+from commitizen import git
 from commitizen.config.base_config import BaseConfig
 
 
@@ -27,8 +28,13 @@ class BaseCommitizen(metaclass=ABCMeta):
     # It can be modified per rule
     commit_parser: Optional[str] = r"(?P<message>.*)"
     changelog_pattern: Optional[str] = r".*"
-    change_type_map: Optional[dict] = None
-    message_hook: Optional[Callable] = None  # (dict, GitCommit) -> dict
+    change_type_map: Optional[Dict[str, str]] = None
+
+    # Executed per message parsed by the commitizen
+    message_hook: Optional[Callable[[Dict, git.GitCommit], Dict]] = None
+
+    # Executed only at the end of the changelog generation
+    changelog_hook: Optional[Callable[[str, Optional[str]], str]] = None
 
     def __init__(self, config: BaseConfig):
         self.config = config

setup.cfg

@@ -35,4 +35,4 @@ exclude =
     build,
     dist
 max-line-length = 88
-max-complexity = 10
+max-complexity = 11

tests/commands/test_changelog_command.py

@@ -5,6 +5,7 @@
 import pytest
 
 from commitizen import cli, git
+from commitizen.commands.changelog import Changelog
 from tests.utils import create_file_and_commit
 
 
@@ -234,3 +235,22 @@ def test_changlog_incremental_keep_a_changelog_sample(mocker, capsys):
         out
         == """# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## Unreleased \n\n### Feat\n\n- add more stuff\n- add new output\n\n### Fix\n\n- mama gotta work\n- output glitch\n\n## [1.0.0] - 2017-06-20\n### Added\n- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).\n- Version navigation.\n\n### Changed\n- Start using "changelog" over "change log" since it\'s the common usage.\n\n### Removed\n- Section about "changelog" vs "CHANGELOG".\n\n## [0.3.0] - 2015-12-03\n### Added\n- RU translation from [@aishek](https://github.com/aishek).\n"""
     )
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_changlog_hook(mocker, config):
+    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")
+
+    changelog = Changelog(
+        config, {"unreleased_version": None, "incremental": True, "dry_run": False,},
+    )
+    mocker.patch.object(changelog.cz, "changelog_hook", changelog_hook_mock)
+    changelog()
+    full_changelog = "\n## Unreleased \n\n### Refactor\n\n- is in changelog\n\n### Feat\n\n- new file\n"
+
+    changelog_hook_mock.assert_called_with(full_changelog, full_changelog)