Merge branch 'master' into feat/unicode

Author: adam-grant-hendry

.pre-commit-config.yaml

@@ -44,7 +44,7 @@ repos:
         args: ["--write-changes", "--ignore-words-list", "asend"]
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v3.5.2 # automatically updated by Commitizen
+    rev: v3.5.4 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch

CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## v3.5.4 (2023-07-29)
+
+### Refactor
+
+- replace SemVer type literals by respective constants
+
+## v3.5.3 (2023-07-15)
+
+### Fix
+
+- Treat $version the same as unset tag_format in ScmProvider
+
+### Refactor
+
+- Make tag_format properly default to $version
+
 ## v3.5.2 (2023-06-25)
 
 ### Fix

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "3.5.2"
+__version__ = "3.5.4"

commitizen/bump.py

@@ -5,7 +5,7 @@
 from collections import OrderedDict
 from string import Template
 
-from commitizen.defaults import bump_message, encoding
+from commitizen.defaults import MAJOR, MINOR, PATCH, bump_message, encoding
 from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit, smart_open
 from commitizen.version_schemes import DEFAULT_SCHEME, Version, VersionScheme
@@ -34,11 +34,11 @@ def find_increment(
                         new_increment = increments_map[match_pattern]
                         break
 
-                if increment == "MAJOR":
+                if increment == MAJOR:
                     break
-                elif increment == "MINOR" and new_increment == "MAJOR":
+                elif increment == MINOR and new_increment == MAJOR:
                     increment = new_increment
-                elif increment == "PATCH" or increment is None:
+                elif increment == PATCH or increment is None:
                     increment = new_increment
 
     return increment
@@ -114,7 +114,7 @@ def _version_to_regex(version: str) -> str:
 
 def normalize_tag(
     version: Version | str,
-    tag_format: str | None = None,
+    tag_format: str,
     scheme: VersionScheme | None = None,
 ) -> str:
     """The tag and the software version might be different.
@@ -131,9 +131,6 @@ def normalize_tag(
     scheme = scheme or DEFAULT_SCHEME
     version = scheme(version) if isinstance(version, str) else version
 
-    if not tag_format:
-        return str(version)
-
     major, minor, patch = version.release
     prerelease = version.prerelease or ""
 

commitizen/commands/changelog.py

@@ -58,8 +58,8 @@ def __init__(self, config: BaseConfig, args):
             or defaults.change_type_order
         )
         self.rev_range = args.get("rev_range")
-        self.tag_format = args.get("tag_format") or self.config.settings.get(
-            "tag_format"
+        self.tag_format: str = (
+            args.get("tag_format") or self.config.settings["tag_format"]
         )
         self.merge_prerelease = args.get(
             "merge_prerelease"

commitizen/commands/init.py

@@ -10,7 +10,7 @@
 from commitizen.__version__ import __version__
 from commitizen.config import BaseConfig, JsonConfig, TomlConfig, YAMLConfig
 from commitizen.cz import registry
-from commitizen.defaults import config_files
+from commitizen.defaults import DEFAULT_SETTINGS, config_files
 from commitizen.exceptions import InitFailedError, NoAnswersError
 from commitizen.git import get_latest_tag_name, get_tag_names, smart_open
 from commitizen.version_schemes import KNOWN_SCHEMES, Version, get_version_scheme
@@ -204,14 +204,15 @@ def _ask_tag_format(self, latest_tag) -> str:
                 f'Is "{tag_format}" the correct tag format?', style=self.cz.style
             ).unsafe_ask()
 
+        default_format = DEFAULT_SETTINGS["tag_format"]
         if not is_correct_format:
             tag_format = questionary.text(
-                'Please enter the correct version format: (default: "$version")',
+                f'Please enter the correct version format: (default: "{default_format}")',
                 style=self.cz.style,
             ).unsafe_ask()
 
             if not tag_format:
-                tag_format = "$version"
+                tag_format = default_format
         return tag_format
 
     def _ask_version_provider(self) -> str:

commitizen/defaults.py

@@ -39,7 +39,7 @@ class Settings(TypedDict, total=False):
     version_provider: str | None
     version_scheme: str | None
     version_type: str | None
-    tag_format: str | None
+    tag_format: str
     bump_message: str | None
     allow_abort: bool
     allowed_prefixes: list[str]
@@ -75,7 +75,7 @@ class Settings(TypedDict, total=False):
     "version_files": [],
     "version_provider": "commitizen",
     "version_scheme": None,
-    "tag_format": None,  # example v$version
+    "tag_format": "$version",  # example v$version
     "bump_message": None,  # bumped v$current_version to $new_version
     "allow_abort": False,
     "allowed_prefixes": [

commitizen/providers.py

@@ -195,9 +195,9 @@ class ScmProvider(VersionProvider):
 
     def _tag_format_matcher(self) -> Callable[[str], str | None]:
         version_scheme = get_version_scheme(self.config)
-        pattern = (
-            self.config.settings.get("tag_format") or version_scheme.parser.pattern
-        )
+        pattern = self.config.settings["tag_format"]
+        if pattern == "$version":
+            pattern = version_scheme.parser.pattern
         for var, tag_pattern in self.TAG_FORMAT_REGEXS.items():
             pattern = pattern.replace(var, tag_pattern)
 

commitizen/version_schemes.py

@@ -191,7 +191,7 @@ def increment_base(self, increment: str | None = None) -> str:
             elif increment == PATCH:
                 base[PATCH] += 1
 
-        return f"{base['MAJOR']}.{base['MINOR']}.{base['PATCH']}"
+        return f"{base[MAJOR]}.{base[MINOR]}.{base[PATCH]}"
 
     def bump(
         self,

docs/bump.md

@@ -317,7 +317,17 @@ cz -nr 21 bump
 
 ### `tag_format`
 
-It is used to read the format from the git tags, and also to generate the tags.
+`tag_format` and `version_scheme` are combined to make Git tag names from versions.
+
+These are used in:
+
+* `cz bump`: Find previous release tag (exact match) and generate new tag.
+* Find previous release tags in `cz changelog`.
+  * If `--incremental`: Using latest version found in the changelog, scan existing Git tags with 89\% similarity match. 
+  * `--rev-range` is converted to Git tag names with `tag_format` before searching Git history.
+* If the `scm` `version_provider` is used, it uses different regexes to find the previous version tags:
+  * If `tag_format` is set to `$version` (default): `VersionProtocol.parser` (allows `v` prefix)
+  * If `tag_format` is set: Custom regex similar to SemVer (not as lenient as PEP440 e.g. on dev-releases)
 
 Commitizen supports 2 types of formats, a simple and a more complex.
 
@@ -336,7 +346,7 @@ In your `pyproject.toml` or `.cz.toml`
 tag_format = "v$major.$minor.$patch$prerelease"
 ```
 
-The variables must be preceded by a `$` sign.
+The variables must be preceded by a `$` sign. Default is `$version`.
 
 Supported variables:
 

docs/config.md

@@ -46,7 +46,7 @@ Select a version scheme from the following options [`pep440`, `semver`]. Useful
 
 Type: `str`
 
-Default: `None`
+Default: `$version`
 
 Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [Read more][tag_format]