feat(customize.py/test_cz_customize.py): inherit from ConventionalCom…

.github/workflows/homebrewpublish.yml

@@ -24,7 +24,7 @@ jobs:
         run: |
           echo "project_version=$(cz version --project)" >> $GITHUB_ENV
       - name: Update Homebrew formula
-        uses: dawidd6/action-homebrew-bump-formula@v3
+        uses: dawidd6/action-homebrew-bump-formula@v4
         with:
           token: ${{secrets.PERSONAL_ACCESS_TOKEN}}
           formula: commitizen

.pre-commit-config.yaml

@@ -49,7 +49,7 @@ repos:
           - tomli
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v3.29.0 # automatically updated by Commitizen
+    rev: v3.30.0 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch

CHANGELOG.md

@@ -1,3 +1,25 @@
+## v3.30.0 (2024-10-23)
+
+### Feat
+
+- **commands/commit**: add force-edit functionality after answering questions
+
+### Refactor
+
+- remove redundant return None
+
+## v3.29.1 (2024-09-26)
+
+### Fix
+
+- **changelog**: Factorized TAG_FORMAT_REGEXES
+- **changelog**: Handle tag format without version pattern
+- **changelog**: handle custom tag_format in changelog generation
+
+### Refactor
+
+- Use format strings
+
 ## v3.29.0 (2024-08-11)
 
 ### Feat

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "3.29.0"
+__version__ = "3.30.0"

commitizen/changelog.py

@@ -44,6 +44,7 @@
 from commitizen import out
 from commitizen.bump import normalize_tag
 from commitizen.cz.base import ChangelogReleaseHook
+from commitizen.defaults import get_tag_regexes
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
 from commitizen.version_schemes import (
@@ -93,16 +94,21 @@ def tag_included_in_changelog(
     return True
 
 
-def get_version_tags(scheme: type[BaseVersion], tags: list[GitTag]) -> list[GitTag]:
+def get_version_tags(
+    scheme: type[BaseVersion], tags: list[GitTag], tag_format: str
+) -> list[GitTag]:
     valid_tags: list[GitTag] = []
+    TAG_FORMAT_REGEXS = get_tag_regexes(scheme.parser.pattern)
+    tag_format_regex = tag_format
+    for pattern, regex in TAG_FORMAT_REGEXS.items():
+        tag_format_regex = tag_format_regex.replace(pattern, regex)
     for tag in tags:
-        try:
-            scheme(tag.name)
-        except InvalidVersion:
-            out.warn(f"InvalidVersion {tag}")
-        else:
+        if re.match(tag_format_regex, tag.name):
             valid_tags.append(tag)
-
+        else:
+            out.warn(
+                f"InvalidVersion {tag.name} doesn't match configured tag format {tag_format}"
+            )
     return valid_tags
 
 
@@ -351,7 +357,6 @@ def get_oldest_and_newest_rev(
         oldest, newest = version.split("..")
     except ValueError:
         newest = version
-
     newest_tag = normalize_tag(newest, tag_format=tag_format, scheme=scheme)
 
     oldest_tag = None

commitizen/changelog_formats/asciidoc.py

@@ -18,7 +18,19 @@ def parse_version_from_title(self, line: str) -> str | None:
         matches = list(re.finditer(self.version_parser, m.group("title")))
         if not matches:
             return None
-        return matches[-1].group("version")
+        if "version" in matches[-1].groupdict():
+            return matches[-1].group("version")
+        partial_matches = matches[-1].groupdict()
+        try:
+            partial_version = f"{partial_matches['major']}.{partial_matches['minor']}.{partial_matches['patch']}"
+        except KeyError:
+            return None
+
+        if partial_matches.get("prerelease"):
+            partial_version = f"{partial_version}-{partial_matches['prerelease']}"
+        if partial_matches.get("devrelease"):
+            partial_version = f"{partial_version}{partial_matches['devrelease']}"
+        return partial_version
 
     def parse_title_level(self, line: str) -> int | None:
         m = self.RE_TITLE.match(line)

commitizen/changelog_formats/base.py

@@ -1,12 +1,14 @@
 from __future__ import annotations
 
 import os
+import re
 from abc import ABCMeta
 from re import Pattern
 from typing import IO, Any, ClassVar
 
 from commitizen.changelog import Metadata
 from commitizen.config.base_config import BaseConfig
+from commitizen.defaults import get_tag_regexes
 from commitizen.version_schemes import get_version_scheme
 
 from . import ChangelogFormat
@@ -25,10 +27,16 @@ def __init__(self, config: BaseConfig):
         # See: https://bugs.python.org/issue44807
         self.config = config
         self.encoding = self.config.settings["encoding"]
+        self.tag_format = self.config.settings["tag_format"]
 
     @property
     def version_parser(self) -> Pattern:
-        return get_version_scheme(self.config).parser
+        tag_regex: str = self.tag_format
+        version_regex = get_version_scheme(self.config).parser.pattern
+        TAG_FORMAT_REGEXS = get_tag_regexes(version_regex)
+        for pattern, regex in TAG_FORMAT_REGEXS.items():
+            tag_regex = tag_regex.replace(pattern, regex)
+        return re.compile(tag_regex)
 
     def get_metadata(self, filepath: str) -> Metadata:
         if not os.path.isfile(filepath):

commitizen/changelog_formats/markdown.py

@@ -19,7 +19,21 @@ def parse_version_from_title(self, line: str) -> str | None:
         m = re.search(self.version_parser, m.group("title"))
         if not m:
             return None
-        return m.group("version")
+        if "version" in m.groupdict():
+            return m.group("version")
+        matches = m.groupdict()
+        try:
+            partial_version = (
+                f"{matches['major']}.{matches['minor']}.{matches['patch']}"
+            )
+        except KeyError:
+            return None
+
+        if matches.get("prerelease"):
+            partial_version = f"{partial_version}-{matches['prerelease']}"
+        if matches.get("devrelease"):
+            partial_version = f"{partial_version}{matches['devrelease']}"
+        return partial_version
 
     def parse_title_level(self, line: str) -> int | None:
         m = self.RE_TITLE.match(line)

commitizen/changelog_formats/restructuredtext.py

@@ -46,7 +46,6 @@ def get_metadata_from_file(self, file: IO[Any]) -> Metadata:
             third = third.strip().lower()
             title: str | None = None
             kind: TitleKind | None = None
-
             if self.is_overlined_title(first, second, third):
                 title = second
                 kind = (first[0], third[0])
@@ -67,10 +66,29 @@ def get_metadata_from_file(self, file: IO[Any]) -> Metadata:
                 # Try to find the latest release done
                 m = re.search(self.version_parser, title)
                 if m:
-                    version = m.group("version")
-                    meta.latest_version = version
-                    meta.latest_version_position = index
-                    break  # there's no need for more info
+                    matches = m.groupdict()
+                    if "version" in matches:
+                        version = m.group("version")
+                        meta.latest_version = version
+                        meta.latest_version_position = index
+                        break  # there's no need for more info
+                    try:
+                        partial_version = (
+                            f"{matches['major']}.{matches['minor']}.{matches['patch']}"
+                        )
+                        if matches.get("prerelease"):
+                            partial_version = (
+                                f"{partial_version}-{matches['prerelease']}"
+                            )
+                        if matches.get("devrelease"):
+                            partial_version = (
+                                f"{partial_version}{matches['devrelease']}"
+                            )
+                        meta.latest_version = partial_version
+                        meta.latest_version_position = index
+                        break
+                    except KeyError:
+                        pass
         if meta.unreleased_start is not None and meta.unreleased_end is None:
             meta.unreleased_end = (
                 meta.latest_version_position if meta.latest_version else index + 1

commitizen/changelog_formats/textile.py

@@ -16,7 +16,24 @@ def parse_version_from_title(self, line: str) -> str | None:
         m = re.search(self.version_parser, line)
         if not m:
             return None
-        return m.group("version")
+        if "version" in m.groupdict():
+            return m.group("version")
+        matches = m.groupdict()
+        if not all(
+            [
+                version_segment in matches
+                for version_segment in ("major", "minor", "patch")
+            ]
+        ):
+            return None
+
+        partial_version = f"{matches['major']}.{matches['minor']}.{matches['patch']}"
+
+        if matches.get("prerelease"):
+            partial_version = f"{partial_version}-{matches['prerelease']}"
+        if matches.get("devrelease"):
+            partial_version = f"{partial_version}{matches['devrelease']}"
+        return partial_version
 
     def parse_title_level(self, line: str) -> int | None:
         m = self.RE_TITLE.match(line)

commitizen/cli.py

@@ -156,6 +156,12 @@ def __call__(
                         "action": "store_true",
                         "help": "Tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected.",
                     },
+                    {
+                        "name": ["-e", "--edit"],
+                        "action": "store_true",
+                        "default": False,
+                        "help": "edit the commit message before committing",
+                    },
                     {
                         "name": ["-l", "--message-length-limit"],
                         "type": int,

commitizen/commands/changelog.py

@@ -168,8 +168,10 @@ def __call__(self):
         # Don't continue if no `file_name` specified.
         assert self.file_name
 
-        tags = changelog.get_version_tags(self.scheme, git.get_tags()) or []
-
+        tags = (
+            changelog.get_version_tags(self.scheme, git.get_tags(), self.tag_format)
+            or []
+        )
         end_rev = ""
         if self.incremental:
             changelog_meta = self.changelog_format.get_metadata(self.file_name)
@@ -182,21 +184,18 @@ def __call__(self):
                 start_rev = self._find_incremental_rev(
                     strip_local_version(latest_tag_version), tags
                 )
-
         if self.rev_range:
             start_rev, end_rev = changelog.get_oldest_and_newest_rev(
                 tags,
                 version=self.rev_range,
                 tag_format=self.tag_format,
                 scheme=self.scheme,
             )
-
         commits = git.get_commits(start=start_rev, end=end_rev, args="--topo-order")
         if not commits and (
             self.current_version is None or not self.current_version.is_prerelease
         ):
             raise NoCommitsFoundError("No commits found")
-
         tree = changelog.generate_tree_from_commits(
             commits,
             tags,

commitizen/commands/commit.py

@@ -2,6 +2,9 @@
 
 import contextlib
 import os
+import shutil
+import subprocess
+import tempfile
 
 import questionary
 
@@ -72,9 +75,27 @@ def prompt_commit_questions(self) -> str:
 
         return message
 
+    def manual_edit(self, message: str) -> str:
+        editor = git.get_core_editor()
+        if editor is None:
+            raise RuntimeError("No 'editor' value given and no default available.")
+        exec_path = shutil.which(editor)
+        if exec_path is None:
+            raise RuntimeError(f"Editor '{editor}' not found.")
+        with tempfile.NamedTemporaryFile(mode="w", delete=False) as file:
+            file.write(message)
+        file_path = file.name
+        argv = [exec_path, file_path]
+        subprocess.call(argv)
+        with open(file_path) as temp_file:
+            message = temp_file.read().strip()
+        file.unlink()
+        return message
+
     def __call__(self):
         dry_run: bool = self.arguments.get("dry_run")
         write_message_to_file: bool = self.arguments.get("write_message_to_file")
+        manual_edit: bool = self.arguments.get("edit")
 
         is_all: bool = self.arguments.get("all")
         if is_all:
@@ -101,6 +122,9 @@ def __call__(self):
         else:
             m = self.prompt_commit_questions()
 
+        if manual_edit:
+            m = self.manual_edit(m)
+
         out.info(f"\n{m}\n")
 
         if write_message_to_file: