fix: only use version tags when generating a changelog

This commit ensures that the tags used to generate the changelog are all correctly parsed by Version()
This fixes two bugs:
- The header of the changelog could be a non-version tag
- The rev-range computed when running  could use a non-version tag as a lower bound

Author: sacha-c

commitizen/changelog.py

@@ -30,14 +30,20 @@
 import re
 from collections import OrderedDict, defaultdict
 from datetime import date
-from typing import TYPE_CHECKING, Callable, Iterable, cast
+from typing import TYPE_CHECKING, Callable, Iterable, Type, cast
 
 from jinja2 import Environment, PackageLoader
 
+from commitizen import out
 from commitizen.bump import normalize_tag
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
-from commitizen.version_schemes import DEFAULT_SCHEME, Pep440, InvalidVersion
+from commitizen.version_schemes import (
+    DEFAULT_SCHEME,
+    BaseVersion,
+    InvalidVersion,
+    Pep440,
+)
 
 if TYPE_CHECKING:
     from commitizen.version_schemes import VersionScheme
@@ -67,6 +73,19 @@ def tag_included_in_changelog(
     return True
 
 
+def get_version_tags(scheme: Type[BaseVersion], tags: list[GitTag]) -> list[GitTag]:
+    valid_tags: list[GitTag] = []
+    for tag in tags:
+        try:
+            scheme(tag.name)
+        except InvalidVersion:
+            out.warn(f"InvalidVersion {tag}")
+        else:
+            valid_tags.append(tag)
+
+    return valid_tags
+
+
 def generate_tree_from_commits(
     commits: list[GitCommit],
     tags: list[GitTag],

commitizen/commands/changelog.py

@@ -137,7 +137,7 @@ def __call__(self):
         # Don't continue if no `file_name` specified.
         assert self.file_name
 
-        tags = git.get_tags()
+        tags = changelog.get_version_tags(self.scheme, git.get_tags())
         if not tags:
             tags = []
 

commitizen/git.py

@@ -92,11 +92,22 @@ def tag(tag: str, annotated: bool = False, signed: bool = False) -> cmd.Command:
     return c
 
 
-def commit(message: str, args: str = "") -> cmd.Command:
+def commit(
+    message: str, args: str = "", committer_date: str | None = None
+) -> cmd.Command:
     f = NamedTemporaryFile("wb", delete=False)
     f.write(message.encode("utf-8"))
     f.close()
-    c = cmd.run(f"git commit {args} -F {f.name}")
+
+    command = f"git commit {args} -F {f.name}"
+
+    if committer_date and os.name == "nt":  # pragma: no cover
+        # Using `cmd /v /c "{command}"` sets environment variables only for that command
+        command = f'cmd /v /c "set GIT_COMMITTER_DATE={committer_date}&& {command}"'
+    elif committer_date:
+        command = f"GIT_COMMITTER_DATE={committer_date} {command}"
+
+    c = cmd.run(command)
     os.unlink(f.name)
     return c
 

poetry.lock

@@ -69,6 +69,9 @@ types-termcolor = "^0.1.1"
 # documentation
 mkdocs = "^1.4.2"
 mkdocs-material = "^9.1.6"
+deprecated = "^1.2.13"
+types-deprecated = "^1.2.9.2"
+types-python-dateutil = "^2.8.19.13"
 
 
 [tool.poetry.scripts]

pyproject.toml

@@ -4,6 +4,7 @@
 
 import pytest
 from pytest_mock import MockFixture
+from dateutil import relativedelta
 
 from commitizen import cli, git
 from commitizen.commands.changelog import Changelog
@@ -17,6 +18,7 @@
 from tests.utils import (
     create_branch,
     create_file_and_commit,
+    create_tag,
     get_current_branch,
     merge_branch,
     switch_branch,
@@ -1267,3 +1269,88 @@ def test_changelog_prerelease_rev_with_use_scheme_semver(
     out, _ = capsys.readouterr()
 
     file_regression.check(out, extension=".second-prerelease.md")
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_changelog_uses_version_tags_for_header(mocker: MockFixture, config):
+    """Tests that changelog headers always use version tags even if there are non-version tags
+
+    This tests a scenario fixed in this commit:
+    The first header was using a non-version tag and outputting "## 0-not-a-version" instead of "## 1.0.0"""
+    create_file_and_commit("feat: commit in 1.0.0")
+    create_tag("0-not-a-version")
+    create_tag("1.0.0")
+    create_tag("also-not-a-version")
+
+    write_patch = mocker.patch("commitizen.commands.changelog.out.write")
+
+    changelog = Changelog(
+        config, {"dry_run": True, "incremental": True, "unreleased_version": None}
+    )
+
+    with pytest.raises(DryRunExit):
+        changelog()
+
+    assert write_patch.call_args[0][0].startswith("## 1.0.0")
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_changelog_from_current_version_tag_with_nonversion_tag(
+    mocker: MockFixture, config
+):
+    """Tests that changelog generation for a single version works even if
+    there is a non-version tag in the list of tags
+
+    This tests a scenario which is fixed in this commit:
+    You have a commit in between two versions (1.0.0..2.0.0) which is tagged with a non-version tag (not-a-version).
+    In this case commitizen should disregard the non-version tag when determining the rev-range & generating the changelog.
+    """
+    create_file_and_commit(
+        "feat: initial commit",
+        committer_date=(
+            datetime.now() - relativedelta.relativedelta(seconds=3)
+        ).isoformat(),
+    )
+    create_tag("1.0.0")
+
+    create_file_and_commit(
+        "feat: commit 1",
+        committer_date=(
+            datetime.now() - relativedelta.relativedelta(seconds=2)
+        ).isoformat(),
+    )
+    create_tag("1-not-a-version")
+
+    create_file_and_commit(
+        "feat: commit 2",
+        committer_date=(
+            datetime.now() - relativedelta.relativedelta(seconds=1)
+        ).isoformat(),
+    )
+
+    create_file_and_commit("bump: version 1.0.0 → 2.0.0")
+    create_tag("2.0.0")
+
+    mocker.patch("commitizen.git.GitTag.date", "2022-02-13")
+    write_patch = mocker.patch("commitizen.commands.changelog.out.write")
+
+    changelog = Changelog(
+        config,
+        {
+            "dry_run": True,
+            "incremental": False,
+            "unreleased_version": None,
+            "rev_range": "2.0.0",
+        },
+    )
+
+    with pytest.raises(DryRunExit):
+        changelog()
+
+    full_changelog = "\
+## 2.0.0 (2022-02-13)\n\n\
+### Feat\n\n\
+- commit 2\n\
+- commit 1\n"
+
+    write_patch.assert_called_with(full_changelog)