feat(changelog): add support for message_hook method

Author: woile

commitizen/changelog.py

@@ -29,7 +29,7 @@
 import re
 from collections import defaultdict
 from datetime import date
-from typing import Dict, Iterable, List, Optional
+from typing import Callable, Dict, Iterable, List, Optional
 
 import pkg_resources
 from jinja2 import Template
@@ -73,6 +73,7 @@ def generate_tree_from_commits(
     changelog_pattern: str = defaults.bump_pattern,
     unreleased_version: Optional[str] = None,
     change_type_map: Optional[Dict[str, str]] = None,
+    message_hook: Optional[Callable] = None,
 ) -> Iterable[Dict]:
     pat = re.compile(changelog_pattern)
     map_pat = re.compile(commit_parser)
@@ -119,6 +120,8 @@ def generate_tree_from_commits(
 
             if change_type_map:
                 change_type = change_type_map.get(change_type, change_type)
+            if message_hook:
+                parsed_message = message_hook(parsed_message, commit)
             changes[change_type].append(parsed_message)
         if message_body:
             parsed_message_body: Dict = message_body.groupdict()

commitizen/commands/changelog.py

@@ -1,7 +1,7 @@
 import os.path
 from difflib import SequenceMatcher
 from operator import itemgetter
-from typing import Dict, List, Optional
+from typing import Callable, Dict, List, Optional
 
 from commitizen import changelog, factory, git, out
 from commitizen.config import BaseConfig
@@ -64,6 +64,7 @@ def __call__(self):
         unreleased_version = self.unreleased_version
         changelog_meta: Dict = {}
         change_type_map: Optional[Dict] = self.change_type_map
+        message_hook: Optional[Callable] = self.cz.message_hook
 
         if not changelog_pattern or not commit_parser:
             out.error(
@@ -92,7 +93,8 @@ def __call__(self):
             commit_parser,
             changelog_pattern,
             unreleased_version,
-            change_type_map,
+            change_type_map=change_type_map,
+            message_hook=message_hook,
         )
         changelog_out = changelog.render_changelog(tree)
 

commitizen/cz/base.py

@@ -1,5 +1,5 @@
 from abc import ABCMeta, abstractmethod
-from typing import List, Optional, Tuple
+from typing import Callable, List, Optional, Tuple
 
 from prompt_toolkit.styles import Style, merge_styles
 
@@ -28,6 +28,7 @@ class BaseCommitizen(metaclass=ABCMeta):
     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
 
     def __init__(self, config: BaseConfig):
         self.config = config

tests/test_changelog.py

@@ -703,7 +703,7 @@ def test_render_changelog_tag_and_unreleased(gitcommits, tags):
     assert "## v1.1.1" in result
 
 
-def test_render_changelog_with_change_type(gitcommits, tags, changelog_content):
+def test_render_changelog_with_change_type(gitcommits, tags):
     new_title = ":some-emoji: feature"
     change_type_map = {"feat": new_title}
     parser = defaults.commit_parser
@@ -713,3 +713,17 @@ def test_render_changelog_with_change_type(gitcommits, tags, changelog_content):
     )
     result = changelog.render_changelog(tree)
     assert new_title in result
+
+
+def test_render_changelog_with_message_hook(gitcommits, tags):
+    def message_hook(message: dict, _) -> dict:
+        message["message"] = f"{message['message']} [link](github.com/232323232)"
+        return message
+
+    parser = defaults.commit_parser
+    changelog_pattern = defaults.bump_pattern
+    tree = changelog.generate_tree_from_commits(
+        gitcommits, tags, parser, changelog_pattern, message_hook=message_hook
+    )
+    result = changelog.render_changelog(tree)
+    assert "[link](github.com/232323232)" in result