Merge branch 'master' into feature/custom-validation

Author: benediktziegler

.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

.github/workflows/pythonpackage.yml

@@ -6,7 +6,7 @@ jobs:
   python-check:
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
         platform: [ubuntu-20.04, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
@@ -30,7 +30,7 @@ jobs:
         shell: bash
       - name: Upload coverage to Codecov
         if: runner.os == 'Linux'
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml

.pre-commit-config.yaml

@@ -4,8 +4,8 @@ default_install_hook_types:
   - pre-push
 
 default_stages:
-  - commit
-  - push
+  - pre-commit
+  - pre-push
 
 repos:
   - repo: meta
@@ -49,13 +49,13 @@ repos:
           - tomli
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v3.29.1 # automatically updated by Commitizen
+    rev: v3.31.0 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch
         stages:
           - post-commit
-          - push
+          - pre-push
 
   - repo: local
     hooks:
@@ -70,6 +70,6 @@ repos:
         name: linter and test
         language: system
         pass_filenames: false
-        stages: [ push ]
+        stages: [ pre-push ]
         entry: ./scripts/test
         types: [ python ]

CHANGELOG.md

@@ -1,3 +1,32 @@
+## v3.31.0 (2024-11-16)
+
+### Feat
+
+- **commitizen**: document '--' double dash in '--help'
+
+### Fix
+
+- **commit**: avoid warnings with 'always_signoff' configuration
+- **commit**: resolve 'always_signoff' configuration and '-s' CLI issues
+
+## v3.30.1 (2024-11-10)
+
+### Refactor
+
+- **cli**: replace magic number 0 with ExitCode.EXPECTED_EXIT
+- **defaults**: disallow style as None
+- **cz_customize**: return empty string for info, example, schema and schema_pattern if not provided
+
+## 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

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "3.29.1"
+__version__ = "3.31.0"

commitizen/cli.py

@@ -156,12 +156,24 @@ 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,
                         "default": 0,
                         "help": "length limit of the commit message; 0 for no limit",
                     },
+                    {
+                        "name": ["--"],
+                        "action": "store_true",
+                        "dest": "double_dash",
+                        "help": "Positional arguments separator (recommended)",
+                    },
                 ],
             },
             {
@@ -541,7 +553,7 @@ def commitizen_excepthook(
             original_excepthook(type, value, traceback)
         exit_code = value.exit_code
         if exit_code in no_raise:
-            exit_code = 0
+            exit_code = ExitCode.EXPECTED_EXIT
         sys.exit(exit_code)
     else:
         original_excepthook(type, value, traceback)

commitizen/commands/check.py

@@ -53,7 +53,7 @@ def _valid_command_argument(self):
             for arg in (self.commit_msg_file, self.commit_msg, self.rev_range)
         )
         if num_exclusive_args_provided == 0 and not sys.stdin.isatty():
-            self.commit_msg: str | None = sys.stdin.read()
+            self.commit_msg = sys.stdin.read()
         elif num_exclusive_args_provided != 1:
             raise InvalidCommandArgumentError(
                 "Only one of --rev-range, --message, and --commit-msg-file is permitted by check command! "
@@ -106,7 +106,9 @@ def _get_commits(self):
             return [git.GitCommit(rev="", title="", body=msg)]
 
         # Get commit messages from git log (--rev-range)
-        return git.get_commits(end=self.rev_range)
+        if self.rev_range:
+            return git.get_commits(end=self.rev_range)
+        return git.get_commits()
 
     @staticmethod
     def _filter_comments(msg: str) -> str:

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:
@@ -110,17 +134,18 @@ def __call__(self):
         if dry_run:
             raise DryRunExit()
 
-        signoff: bool = (
-            self.arguments.get("signoff") or self.config.settings["always_signoff"]
-        )
+        always_signoff: bool = self.config.settings["always_signoff"]
+        signoff: bool = self.arguments.get("signoff")
+
+        extra_args = self.arguments.get("extra_cli_args", "")
 
         if signoff:
             out.warn(
                 "signoff mechanic is deprecated, please use `cz commit -- -s` instead."
             )
-            extra_args = self.arguments.get("extra_cli_args", "--") + " -s"
-        else:
-            extra_args = self.arguments.get("extra_cli_args", "")
+
+        if always_signoff or signoff:
+            extra_args = f"{extra_args} -s".strip()
 
         c = git.commit(m, args=extra_args)
 

commitizen/cz/base.py

@@ -67,7 +67,7 @@ class BaseCommitizen(metaclass=ABCMeta):
     template_loader: BaseLoader = PackageLoader("commitizen", "templates")
     template_extras: dict[str, Any] = {}
 
-    def __init__(self, config: BaseConfig):
+    def __init__(self, config: BaseConfig) -> None:
         self.config = config
         if not self.config.settings.get("style"):
             self.config.settings.update({"style": BaseCommitizen.default_style_config})
@@ -89,15 +89,15 @@ def style(self):
             ]
         )
 
-    def example(self) -> str | None:
+    def example(self) -> str:
         """Example of the commit message."""
         raise NotImplementedError("Not Implemented yet")
 
-    def schema(self) -> str | None:
+    def schema(self) -> str:
         """Schema definition of the commit message."""
         raise NotImplementedError("Not Implemented yet")
 
-    def schema_pattern(self) -> str | None:
+    def schema_pattern(self) -> str:
         """Regex matching the schema used for message validation."""
         raise NotImplementedError("Not Implemented yet")
 
@@ -142,7 +142,7 @@ def format_exception_message(
             f"pattern: {self.schema_pattern()}"
         )
 
-    def info(self) -> str | None:
+    def info(self) -> str:
         """Information about the standardized commit message."""
         raise NotImplementedError("Not Implemented yet")
 

commitizen/cz/customize/customize.py

@@ -1,9 +1,14 @@
 from __future__ import annotations
 
-try:
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
     from jinja2 import Template
-except ImportError:
-    from string import Template  # type: ignore
+else:
+    try:
+        from jinja2 import Template
+    except ImportError:
+        from string import Template
 
 
 from commitizen import defaults
@@ -68,16 +73,16 @@ def message(self, answers: dict) -> str:
         else:
             return message_template.render(**answers)
 
-    def example(self) -> str | None:
-        return self.custom_settings.get("example")
+    def example(self) -> str:
+        return self.custom_settings.get("example") or ""
 
-    def schema_pattern(self) -> str | None:
-        return self.custom_settings.get("schema_pattern")
+    def schema_pattern(self) -> str:
+        return self.custom_settings.get("schema_pattern") or ""
 
-    def schema(self) -> str | None:
-        return self.custom_settings.get("schema")
+    def schema(self) -> str:
+        return self.custom_settings.get("schema") or ""
 
-    def info(self) -> str | None:
+    def info(self) -> str:
         info_path = self.custom_settings.get("info_path")
         info = self.custom_settings.get("info")
         if info_path:
@@ -86,4 +91,4 @@ def info(self) -> str | None:
             return content
         elif info:
             return info
-        return None
+        return ""