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

Closes #399 #225

Author: woile

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 Any, Callable, Dict, Iterable, List, Optional, Tuple
 
 from jinja2 import Environment, PackageLoader
 
@@ -281,3 +281,49 @@ 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]) -> 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_star_and_end_rev(
+    tags: List[GitTag], version: str, tag_format: str, create_tag: Callable
+) -> Tuple[str, Any]:
+    left: Optional[str] = None
+    right: Optional[str] = None
+
+    try:
+        left, right = version.split("..")
+    except ValueError:
+        right = version
+
+    if right:
+        rtag = create_tag(right, tag_format=tag_format)
+    else:
+        rtag = None
+    if left:
+        ltag = create_tag(left, tag_format=tag_format)
+    else:
+        ltag = None
+
+    tags = get_tag_range(tags, start=rtag, end=ltag)
+    start_rev = tags[-1].name
+    end_rev = rtag
+    return start_rev, end_rev

commitizen/cli.py

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

commitizen/commands/changelog.py

@@ -3,7 +3,7 @@
 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,
@@ -46,6 +46,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.version = args.get("version_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'.
@@ -93,13 +97,24 @@ def __call__(self):
         if not tags:
             tags = []
 
+        end_rev = "HEAD"
+        if self.version and self.tag_format:
+            start_rev, end_rev = changelog.get_star_and_end_rev(
+                tags,
+                version=self.version,
+                tag_format=self.tag_format,
+                create_tag=bump.create_tag,
+            )
+
         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")
+        commits = git.get_commits(
+            start=start_rev, end=end_rev, args="--author-date-order"
+        )
         if not commits:
             raise NoCommitsFoundError("No commits found")