feat(changelog): add merge_prereleases flag

Author: MoritzBoehme

commitizen/changelog.py

@@ -32,6 +32,7 @@
 from typing import Callable, Dict, Iterable, List, Optional, Tuple
 
 from jinja2 import Environment, PackageLoader
+from packaging.version import InvalidVersion, Version
 
 from commitizen import defaults
 from commitizen.bump import normalize_tag
@@ -43,6 +44,15 @@ def get_commit_tag(commit: GitCommit, tags: List[GitTag]) -> Optional[GitTag]:
     return next((tag for tag in tags if tag.rev == commit.rev), None)
 
 
+def get_version(tag: GitTag) -> Optional[Version]:
+    version = None
+    try:
+        version = Version(tag.name)
+    except InvalidVersion:
+        pass
+    return version
+
+
 def generate_tree_from_commits(
     commits: List[GitCommit],
     tags: List[GitTag],
@@ -51,6 +61,7 @@ def generate_tree_from_commits(
     unreleased_version: Optional[str] = None,
     change_type_map: Optional[Dict[str, str]] = None,
     changelog_message_builder_hook: Optional[Callable] = None,
+    merge_prerelease: bool = False,
 ) -> Iterable[Dict]:
     pat = re.compile(changelog_pattern)
     map_pat = re.compile(commit_parser, re.MULTILINE)
@@ -73,15 +84,18 @@ def generate_tree_from_commits(
     for commit in commits:
         commit_tag = get_commit_tag(commit, tags)
 
-        if commit_tag is not None and commit_tag not in used_tags:
+        if (
+            commit_tag is not None
+            and commit_tag not in used_tags
+            and get_version(commit_tag) is not None
+            and not (merge_prerelease and get_version(commit_tag).is_prerelease)
+        ):
             used_tags.append(commit_tag)
             yield {
                 "version": current_tag_name,
                 "date": current_tag_date,
                 "changes": changes,
             }
-            # TODO: Check if tag matches the version pattern, otherwise skip it.
-            # This in order to prevent tags that are not versions.
             current_tag_name = commit_tag.name
             current_tag_date = commit_tag.date
             changes = defaultdict(list)

commitizen/cli.py

@@ -247,10 +247,19 @@
                         "name": "--start-rev",
                         "default": None,
                         "help": (
-                            "start rev of the changelog."
+                            "start rev of the changelog. "
                             "If not set, it will generate changelog from the start"
                         ),
                     },
+                    {
+                        "name": "--merge-prerelease",
+                        "action": "store_true",
+                        "default": False,
+                        "help": (
+                            "collect all changes from prereleases into next 'normal' release. "
+                            "If not set, it will include prereleases in the changelog"
+                        ),
+                    },
                 ],
             },
             {

commitizen/commands/changelog.py

@@ -49,6 +49,9 @@ def __init__(self, config: BaseConfig, args):
         self.tag_format = args.get("tag_format") or self.config.settings.get(
             "tag_format"
         )
+        self.merge_prerelease = args.get(
+            "merge_prerelease"
+        ) or self.config.settings.get("merge_prerelease")
 
     def _find_incremental_rev(self, latest_version: str, tags: List[GitTag]) -> str:
         """Try to find the 'start_rev'.
@@ -110,6 +113,7 @@ def __call__(self):
         changelog_message_builder_hook: Optional[
             Callable
         ] = self.cz.changelog_message_builder_hook
+        merge_prerelease = self.merge_prerelease
 
         if not changelog_pattern or not commit_parser:
             raise NoPatternMapError(
@@ -158,6 +162,7 @@ def __call__(self):
             unreleased_version,
             change_type_map=change_type_map,
             changelog_message_builder_hook=changelog_message_builder_hook,
+            merge_prerelease=merge_prerelease,
         )
         if self.change_type_order:
             tree = changelog.order_changelog_tree(tree, self.change_type_order)

commitizen/defaults.py

@@ -39,6 +39,7 @@ class Settings(TypedDict, total=False):
     changelog_file: str
     changelog_incremental: bool
     changelog_start_rev: Optional[str]
+    changelog_merge_prerelease: bool
     update_changelog_on_bump: bool
     use_shortcuts: bool
     style: Optional[List[Tuple[str, str]]]
@@ -69,6 +70,7 @@ class Settings(TypedDict, total=False):
     "changelog_file": "CHANGELOG.md",
     "changelog_incremental": False,
     "changelog_start_rev": None,
+    "changelog_merge_prerelease": False,
     "update_changelog_on_bump": False,
     "use_shortcuts": False,
     "major_version_zero": False,

docs/changelog.md

@@ -21,7 +21,9 @@ optional arguments:
                         set the value for the new version (use the tag value), instead of using unreleased
   --incremental         generates changelog from last created version, useful if the changelog has been manually modified
   --start-rev START_REV
-                        start rev of the changelog.If not set, it will generate changelog from the start
+                        start rev of the changelog. If not set, it will generate changelog from the start
+  --merge-prerelease
+                        collect all changes from prereleases into next 'normal' release. If not set, it will include prereleases in the changelog
 ```
 
 ### Examples

tests/commands/test_changelog_command.py

@@ -461,6 +461,40 @@ def test_changelog_config_flag_increment(
     file_regression.check(out, extension=".md")
 
 
+@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"])
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_changelog_config_flag_merge_prerelease(
+    mocker: MockFixture, changelog_path, config_path, file_regression, test_input
+):
+    with open(config_path, "a") as f:
+        f.write("merge_prerelease = true\n")
+
+    create_file_and_commit("irrelevant commit")
+    mocker.patch("commitizen.git.GitTag.date", "1970-01-01")
+    git.tag("1.0.0")
+
+    create_file_and_commit("feat: add new output")
+    create_file_and_commit("fix: output glitch")
+
+    testargs = ["cz", "bump", "--prerelease", test_input, "--yes"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    create_file_and_commit("fix: mama gotta work")
+    create_file_and_commit("feat: add more stuff")
+    create_file_and_commit("Merge into master")
+
+    testargs = ["cz", "changelog"]
+
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    with open(changelog_path, "r") as f:
+        out = f.read()
+
+    file_regression.check(out, extension=".md")
+
+
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_config_start_rev_option(
     mocker: MockFixture, capsys, config_path, file_regression
@@ -549,6 +583,40 @@ def test_changelog_incremental_with_release_candidate_version(
     file_regression.check(out, extension=".md")
 
 
+@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"])
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_changelog_release_candidate_version_with_merge_prerelease(
+    mocker: MockFixture, changelog_path, file_regression, test_input
+):
+    """Fix #357"""
+    with open(changelog_path, "w") as f:
+        f.write(KEEP_A_CHANGELOG)
+    create_file_and_commit("irrelevant commit")
+    mocker.patch("commitizen.git.GitTag.date", "1970-01-01")
+    git.tag("1.0.0")
+
+    create_file_and_commit("feat: add new output")
+    create_file_and_commit("fix: output glitch")
+
+    testargs = ["cz", "bump", "--prerelease", test_input, "--yes"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    create_file_and_commit("fix: mama gotta work")
+    create_file_and_commit("feat: add more stuff")
+    create_file_and_commit("Merge into master")
+
+    testargs = ["cz", "changelog", "--merge-prerelease"]
+
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    with open(changelog_path, "r") as f:
+        out = f.read()
+
+    file_regression.check(out, extension=".md")
+
+
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_with_filename_as_empty_string(
     mocker: MockFixture, changelog_path, config_path

tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_alpha_.md

@@ -0,0 +1,13 @@
+## Unreleased
+
+### Feat
+
+- add more stuff
+- add new output
+
+### Fix
+
+- mama gotta work
+- output glitch
+
+## 1.0.0 (1970-01-01)

tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_beta_.md

@@ -0,0 +1,13 @@
+## Unreleased
+
+### Feat
+
+- add more stuff
+- add new output
+
+### Fix
+
+- mama gotta work
+- output glitch
+
+## 1.0.0 (1970-01-01)

tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_rc_.md

@@ -0,0 +1,13 @@
+## Unreleased
+
+### Feat
+
+- add more stuff
+- add new output
+
+### Fix
+
+- mama gotta work
+- output glitch
+
+## 1.0.0 (1970-01-01)

tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_alpha_.md

@@ -0,0 +1,13 @@
+## Unreleased
+
+### Feat
+
+- add more stuff
+- add new output
+
+### Fix
+
+- mama gotta work
+- output glitch
+
+## 1.0.0 (1970-01-01)