feat(changelog): add support for single version and version range

Closes #399 #225

Author: woile

commitizen/bump.py

@@ -21,7 +21,7 @@ def find_increment(
     # Most important cases are major and minor.
     # Everything else will be considered patch.
     select_pattern = re.compile(regex)
-    increment = None
+    increment: Optional[str] = None
 
     for commit in commits:
         for message in commit.message.split("\n"):

commitizen/changelog.py

@@ -29,7 +29,7 @@
 import re
 from collections import OrderedDict, defaultdict
 from datetime import date
-from typing import Callable, Dict, Iterable, List, Optional
+from typing import Callable, Dict, Iterable, List, Optional, Tuple
 
 from jinja2 import Environment, PackageLoader
 
@@ -281,3 +281,48 @@ def incremental_build(new_content: str, lines: List, metadata: Dict) -> List:
     if not isinstance(latest_version_position, int):
         output_lines.append(new_content)
     return output_lines
+
+
+def get_tag_range(tags: List[GitTag], start: str, end: Optional[str] = None) -> List[GitTag]:
+    accumulator = []
+    keep = False
+    if not end:
+        end = start
+    for index, tag in enumerate(tags):
+        if tag.name == start:
+            keep = True
+        if keep:
+            accumulator.append(tag)
+        if tag.name == end:
+            keep = False
+            try:
+                accumulator.append(tags[index + 1])
+            except IndexError:
+                pass
+            break
+    return accumulator
+
+
+def get_start_and_end_rev(
+    tags: List[GitTag], version: str, tag_format: str, create_tag: Callable
+) -> Tuple[Optional[str], Optional[str]]:
+    start: Optional[str] = None
+    end: Optional[str] = None
+
+    try:
+        start, end = version.split("..")
+    except ValueError:
+        end = version
+
+    end_tag = create_tag(end, tag_format=tag_format)
+
+    start_tag = None
+    if start:
+        start_tag = create_tag(start, tag_format=tag_format)
+
+    tags = get_tag_range(tags, start=end_tag, end=start_tag)
+    if len(tags) == 0:
+        return None, None
+    start_rev = tags[-1].name
+    end_rev = end_tag
+    return start_rev, end_rev

commitizen/cli.py

@@ -188,6 +188,12 @@
                             "useful if the changelog has been manually modified"
                         ),
                     },
+                    {
+                        "name": "rev_range",
+                        "type": str,
+                        "nargs": "?",
+                        "help": "generates changelog for the given version range",
+                    },
                     {
                         "name": "--start-rev",
                         "default": None,

commitizen/commands/changelog.py

@@ -3,14 +3,15 @@
 from operator import itemgetter
 from typing import Callable, Dict, List, Optional
 
-from commitizen import changelog, factory, git, out
+from commitizen import bump, changelog, factory, git, out
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
     DryRunExit,
     NoCommitsFoundError,
     NoPatternMapError,
     NoRevisionError,
     NotAGitProjectError,
+    NotAllowed,
 )
 from commitizen.git import GitTag
 
@@ -46,6 +47,10 @@ def __init__(self, config: BaseConfig, args):
         self.change_type_order = (
             self.config.settings.get("change_type_order") or self.cz.change_type_order
         )
+        self.rev_range = args.get("rev_range")
+        self.tag_format = args.get("tag_format") or self.config.settings.get(
+            "tag_format"
+        )
 
     def _find_incremental_rev(self, latest_version: str, tags: List[GitTag]) -> str:
         """Try to find the 'start_rev'.
@@ -89,17 +94,32 @@ def __call__(self):
                 f"'{self.config.settings['name']}' rule does not support changelog"
             )
 
+        if self.incremental and self.rev_range:
+            raise NotAllowed("--incremental cannot be combined with a rev_range")
+
         tags = git.get_tags()
         if not tags:
             tags = []
 
+        end_rev = "HEAD"
+
         if self.incremental:
             changelog_meta = changelog.get_metadata(self.file_name)
             latest_version = changelog_meta.get("latest_version")
             if latest_version:
                 start_rev = self._find_incremental_rev(latest_version, tags)
 
-        commits = git.get_commits(start=start_rev, args="--author-date-order")
+        if self.rev_range and self.tag_format:
+            start_rev, end_rev = changelog.get_start_and_end_rev(
+                tags,
+                version=self.rev_range,
+                tag_format=self.tag_format,
+                create_tag=bump.create_tag,
+            )
+
+        commits = git.get_commits(
+            start=start_rev, end=end_rev, args="--author-date-order"
+        )
         if not commits:
             raise NoCommitsFoundError("No commits found")
 

commitizen/exceptions.py

@@ -24,6 +24,7 @@ class ExitCode(enum.IntEnum):
     CURRENT_VERSION_NOT_FOUND = 17
     INVALID_COMMAND_ARGUMENT = 18
     INVALID_CONFIGURATION = 19
+    NOT_ALLOWED = 20
 
 
 class CommitizenException(Exception):
@@ -142,3 +143,7 @@ class InvalidCommandArgumentError(CommitizenException):
 
 class InvalidConfigurationError(CommitizenException):
     exit_code = ExitCode.INVALID_CONFIGURATION
+
+
+class NotAllowed(CommitizenException):
+    exit_code = ExitCode.NOT_ALLOWED

scripts/test

@@ -5,7 +5,7 @@ if [ -d 'venv' ] ; then
     export PREFIX="venv/bin/"
 fi
 
-${PREFIX}pytest --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen tests/
+${PREFIX}pytest -x -s --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen tests/
 ${PREFIX}black commitizen tests --check
 ${PREFIX}isort --check-only commitizen tests
 ${PREFIX}flake8 commitizen/ tests/

tests/commands/test_changelog_command.py

@@ -279,7 +279,7 @@ def test_changelog_multiple_incremental_do_not_add_new_lines(
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
 
-    create_file_and_commit("fix: mama gotta work")
+    create_file_and_commit("fix: no more explosions")
 
     testargs = ["cz", "changelog", "--incremental"]
     mocker.patch.object(sys, "argv", testargs)
@@ -514,3 +514,38 @@ def test_changelog_incremental_with_release_candidate_version(
         out = f.read()
 
     file_regression.check(out, extension=".md")
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_changelog_multiple_incremental_do_not_add_new_lines(
+    mocker, capsys, changelog_path
+):
+    """Test for bug https://github.com/commitizen-tools/commitizen/issues/192"""
+    create_file_and_commit("feat: add new output")
+
+    testargs = ["cz", "changelog", "--incremental"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    create_file_and_commit("fix: output glitch")
+
+    testargs = ["cz", "changelog", "--incremental"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    create_file_and_commit("fix: no more explosions")
+
+    testargs = ["cz", "changelog", "--incremental"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    create_file_and_commit("feat: add more stuff")
+
+    testargs = ["cz", "changelog", "--incremental"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+
+    with open(changelog_path, "r") as f:
+        out = f.read()
+
+    assert out.startswith("#")

tests/test_changelog.py

@@ -912,3 +912,15 @@ def changelog_message_builder_hook(message: dict, commit: git.GitCommit) -> dict
     result = changelog.render_changelog(tree)
 
     assert "[link](github.com/232323232) Commitizen author@cz.dev" in result
+
+
+def test_get_tag_range_returns_an_extra_for_a_range(tags):
+    start, end = tags[0], tags[2]  # len here is 3, but we expect one more tag as designed
+    res = changelog.get_tag_range(tags, start.name, end.name)
+    assert 4 == len(res)
+
+
+def test_get_tag_range_returns_an_extra_for_a_single_tag(tags):
+    start = tags[0]  # len here is 1, but we expect one more tag as designed
+    res = changelog.get_tag_range(tags, start.name)
+    assert 2 == len(res)