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

Closes commitizen-tools#399 commitizen-tools#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,72 @@ 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_smart_tag_range(
+    tags: List[GitTag], start: str, end: Optional[str] = None
+) -> List[GitTag]:
+    """Smart because it finds the N+1 tag.
+
+    This is because we need to find until the next tag
+    """
+    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]]:
+    """Find the tags for the given version.
+
+    `version` may come in different formats:
+    - `0.1.0..0.4.0`: as a range
+    - `0.3.0`: as a single version
+    """
+    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_range = get_smart_tag_range(tags, start=end_tag, end=start_tag)
+    if len(tags_range) == 0:
+        return None, None
+
+    start_rev: Optional[str] = tags_range[-1].name
+    end_rev = end_tag
+
+    # check if it's the first tag created
+    # and it's also being requested as part of the range
+    if start_rev == tags[-1].name and start_rev == start_tag:
+        return None, end_rev
+
+    # when they are the same, and it's also the
+    # first tag crated
+    if start_rev == end_rev:
+        return None, end_rev
+
+    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 (e.g: 1.5.3) or version range (e.g: 1.5.3..1.7.9)",
+                    },
                     {
                         "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'.
@@ -73,6 +78,30 @@ def _find_incremental_rev(self, latest_version: str, tags: List[GitTag]) -> str:
         start_rev = tag.name
         return start_rev
 
+    def write_changelog(
+        self, changelog_out: str, lines: List[str], changelog_meta: Dict
+    ):
+        if not isinstance(self.file_name, str):
+            raise NotAllowed(
+                "Changelog file name is broken.\n"
+                "Check the flag `--file-name` in the terminal "
+                f"or the setting `changelog_file` in {self.config.path}"
+            )
+
+        changelog_hook: Optional[Callable] = self.cz.changelog_hook
+        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_out = "".join(new_lines)
+                partial_changelog = changelog_out
+
+            if changelog_hook:
+                changelog_out = changelog_hook(changelog_out, partial_changelog)
+            changelog_file.write(changelog_out)
+
     def __call__(self):
         commit_parser = self.cz.commit_parser
         changelog_pattern = self.cz.changelog_pattern
@@ -83,23 +112,38 @@ def __call__(self):
         changelog_message_builder_hook: Optional[
             Callable
         ] = self.cz.changelog_message_builder_hook
-        changelog_hook: Optional[Callable] = self.cz.changelog_hook
+
         if not changelog_pattern or not commit_parser:
             raise NoPatternMapError(
                 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")
 
@@ -126,15 +170,4 @@ def __call__(self):
             with open(self.file_name, "r") as changelog_file:
                 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_out = "".join(new_lines)
-                partial_changelog = changelog_out
-
-            if changelog_hook:
-                changelog_out = changelog_hook(changelog_out, partial_changelog)
-            changelog_file.write(changelog_out)
+        self.write_changelog(changelog_out, lines, changelog_meta)

commitizen/cz/__init__.py

@@ -23,7 +23,7 @@ def discover_plugins(path: Iterable[str] = None) -> Dict[str, Type[BaseCommitize
     for finder, name, ispkg in pkgutil.iter_modules(path):
         try:
             if name.startswith("cz_"):
-                plugins[name] = importlib.import_module(name).discover_this  # type: ignore
+                plugins[name] = importlib.import_module(name).discover_this
         except AttributeError as e:
             warnings.warn(UserWarning(e.args[0]))
             continue

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

pyproject.toml

@@ -72,7 +72,7 @@ isort = "^5.7.0"
 # linter
 flake8 = "^3.6"
 pre-commit = "^2.6.0"
-mypy = "0.910"
+mypy = "^0.931"
 types-PyYAML = "^5.4.3"
 types-termcolor = "^0.1.1"
 # documentation