Merge branch 'v5' into issue-1119

Author: paduszyk

.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.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.30.0 # automatically updated by Commitizen
+    rev: v4.0.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 ]

.pre-commit-hooks.yaml

@@ -4,8 +4,8 @@
     Check whether the current commit message follows committing rules. Allow
     empty commit messages by default, because they typically indicate to Git
     that the commit should be aborted.
-  entry: cz check
-  args: [--allow-abort, --commit-msg-file]
+  entry: cz
+  args: [check, --allow-abort, --commit-msg-file]
   stages: [commit-msg]
   language: python
   language_version: python3
@@ -18,8 +18,8 @@
     default branch on the origin repository. Useful for checking messages after
     the fact (e.g., pre-push or in CI) without an expensive check of the entire
     repository history.
-  entry: cz check
-  args: [--rev-range, origin/HEAD..HEAD]
+  entry: cz
+  args: [--no-raise, '3', check, --rev-range, origin/HEAD..HEAD]
   always_run: true
   pass_filenames: false
   language: python

CHANGELOG.md

@@ -1,3 +1,24 @@
+## v4.0.0 (2024-11-26)
+
+## 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

commitizen/__version__.py

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

commitizen/changelog.py

@@ -29,9 +29,10 @@
 
 import re
 from collections import OrderedDict, defaultdict
+from collections.abc import Iterable
 from dataclasses import dataclass
 from datetime import date
-from typing import TYPE_CHECKING, Iterable
+from typing import TYPE_CHECKING
 
 from jinja2 import (
     BaseLoader,

commitizen/changelog_formats/restructuredtext.py

@@ -3,7 +3,7 @@
 import re
 import sys
 from itertools import zip_longest
-from typing import IO, TYPE_CHECKING, Any, Tuple, Union
+from typing import IO, TYPE_CHECKING, Any, Union
 
 from commitizen.changelog import Metadata
 
@@ -18,7 +18,7 @@
 
 
 # Can't use `|` operator and native type because of https://bugs.python.org/issue42233 only fixed in 3.10
-TitleKind: TypeAlias = Union[str, Tuple[str, str]]
+TitleKind: TypeAlias = Union[str, tuple[str, str]]
 
 
 class RestructuredText(BaseFormat):

commitizen/cli.py

@@ -3,11 +3,12 @@
 import argparse
 import logging
 import sys
+from collections.abc import Sequence
 from copy import deepcopy
 from functools import partial
 from pathlib import Path
 from types import TracebackType
-from typing import Any, Sequence
+from typing import Any
 
 import argcomplete
 from decli import cli
@@ -168,6 +169,12 @@ def __call__(
                         "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)",
+                    },
                 ],
             },
             {
@@ -547,7 +554,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

@@ -54,7 +54,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! "
@@ -107,7 +107,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

@@ -134,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)