feat(bump): version_provider=semver optional option to make version compatible with semver

Signed-off-by: apkawa <[email protected]>

Author: Apkawa

commitizen/bump.py

@@ -3,7 +3,7 @@
 from collections import OrderedDict
 from itertools import zip_longest
 from string import Template
-from typing import List, Optional, Tuple, Union
+from typing import List, Optional, Tuple, Type, Union
 
 from packaging.version import Version
 
@@ -120,6 +120,7 @@ def generate_version(
     prerelease_offset: int = 0,
     devrelease: Optional[int] = None,
     is_local_version: bool = False,
+    version_provider_cls: Optional[Type[Version]] = None,
 ) -> Version:
     """Based on the given increment a proper semver will be generated.
 
@@ -132,15 +133,18 @@ def generate_version(
         MINOR 1.0.0 -> 1.1.0
         MAJOR 1.0.0 -> 2.0.0
     """
+    version_provider_cls = version_provider_cls or Version
     if is_local_version:
-        version = Version(current_version)
+        version = version_provider_cls(current_version)
         dev_version = devrelease_generator(devrelease=devrelease)
         pre_version = prerelease_generator(
             str(version.local), prerelease=prerelease, offset=prerelease_offset
         )
         semver = semver_generator(str(version.local), increment=increment)
 
-        return Version(f"{version.public}+{semver}{pre_version}{dev_version}")
+        return version_provider_cls(
+            f"{version.public}+{semver}{pre_version}{dev_version}"
+        )
     else:
         dev_version = devrelease_generator(devrelease=devrelease)
         pre_version = prerelease_generator(
@@ -149,7 +153,7 @@ def generate_version(
         semver = semver_generator(current_version, increment=increment)
 
         # TODO: post version
-        return Version(f"{semver}{pre_version}{dev_version}")
+        return version_provider_cls(f"{semver}{pre_version}{dev_version}")
 
 
 def update_version_in_files(
@@ -208,7 +212,9 @@ def _version_to_regex(version: str) -> str:
 
 
 def normalize_tag(
-    version: Union[Version, str], tag_format: Optional[str] = None
+    version: Union[Version, str],
+    tag_format: Optional[str] = None,
+    version_provider_cls: Optional[Type[Version]] = None,
 ) -> str:
     """The tag and the software version might be different.
 
@@ -221,8 +227,9 @@ def normalize_tag(
     | ver1.0.0 | 1.0.0 |
     | ver1.0.0.a0 | 1.0.0a0 |
     """
+    version_provider_cls = version_provider_cls or Version
     if isinstance(version, str):
-        version = Version(version)
+        version = version_provider_cls(version)
 
     if not tag_format:
         return str(version)

commitizen/cli.py

@@ -8,7 +8,7 @@
 import argcomplete
 from decli import cli
 
-from commitizen import commands, config, out
+from commitizen import commands, config, out, version_providers
 from commitizen.exceptions import (
     CommitizenException,
     ExitCode,
@@ -203,6 +203,12 @@
                         "help": "bump to the given version (e.g: 1.5.3)",
                         "metavar": "MANUAL_VERSION",
                     },
+                    {
+                        "name": ["--version-provider"],
+                        "help": "choose version provider",
+                        "default": None,
+                        "choices": version_providers.providers,
+                    },
                 ],
             },
             {

commitizen/commands/bump.py

@@ -5,7 +5,7 @@
 import questionary
 from packaging.version import InvalidVersion, Version
 
-from commitizen import bump, cmd, defaults, factory, git, hooks, out
+from commitizen import bump, cmd, defaults, factory, git, hooks, out, version_providers
 from commitizen.commands.changelog import Changelog
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
@@ -62,6 +62,12 @@ def __init__(self, config: BaseConfig, arguments: dict):
         self.retry = arguments["retry"]
         self.pre_bump_hooks = self.config.settings["pre_bump_hooks"]
         self.post_bump_hooks = self.config.settings["post_bump_hooks"]
+        version_provider = arguments["version_provider"] or self.config.settings.get(
+            "version_provider"
+        )
+        self.version_provider = (
+            version_provider and version_providers.providers[version_provider]
+        )
 
     def is_initial_tag(self, current_tag_version: str, is_yes: bool = False) -> bool:
         """Check if reading the whole git tree up to HEAD is needed."""
@@ -153,7 +159,9 @@ def __call__(self):  # noqa: C901
             self.cz.bump_map = defaults.bump_map_major_version_zero
 
         current_tag_version: str = bump.normalize_tag(
-            current_version, tag_format=tag_format
+            current_version,
+            tag_format=tag_format,
+            version_provider_cls=self.version_provider,
         )
 
         is_initial = self.is_initial_tag(current_tag_version, is_yes)
@@ -209,9 +217,14 @@ def __call__(self):  # noqa: C901
                 prerelease_offset=prerelease_offset,
                 devrelease=devrelease,
                 is_local_version=is_local_version,
+                version_provider_cls=self.version_provider,
             )
 
-        new_tag_version = bump.normalize_tag(new_version, tag_format=tag_format)
+        new_tag_version = bump.normalize_tag(
+            new_version,
+            tag_format=tag_format,
+            version_provider_cls=self.version_provider,
+        )
         message = bump.create_commit_message(
             current_version, new_version, bump_commit_message
         )

commitizen/defaults.py

@@ -45,6 +45,7 @@ class Settings(TypedDict, total=False):
     pre_bump_hooks: Optional[List[str]]
     post_bump_hooks: Optional[List[str]]
     prerelease_offset: int
+    version_provider: Optional[str]
 
 
 name: str = "cz_conventional_commits"
@@ -75,6 +76,7 @@ class Settings(TypedDict, total=False):
     "pre_bump_hooks": [],
     "post_bump_hooks": [],
     "prerelease_offset": 0,
+    "version_provider": None,
 }
 
 MAJOR = "MAJOR"

commitizen/version_providers.py

@@ -0,0 +1,38 @@
+from packaging.version import Version
+
+
+class SemVerVersion(Version):
+    def __str__(self) -> str:
+        parts = []
+
+        # Epoch
+        if self.epoch != 0:
+            parts.append(f"{self.epoch}!")
+
+        # Release segment
+        parts.append(".".join(str(x) for x in self.release))
+
+        # Pre-release
+        if self.pre is not None:
+            pre = "".join(str(x) for x in self.pre)
+            parts.append(f"-{pre}")
+
+        # Post-release
+        if self.post is not None:
+            parts.append(f"-post{self.post}")
+
+        # Development release
+        if self.dev is not None:
+            parts.append(f"-dev{self.dev}")
+
+        # Local version segment
+        if self.local is not None:
+            parts.append(f"+{self.local}")
+
+        return "".join(parts)
+
+
+providers = {
+    "pep": Version,
+    "semver": SemVerVersion,
+}

docs/bump.md

@@ -96,6 +96,9 @@ options:
   --retry               retry commit if it fails the 1st time
   --major-version-zero  keep major version at zero, even for breaking changes
   --prerelease-offset   start pre-releases with this offset
+  --version-provider {pep,semver}
+                        choose version provider
+
 ```
 
 ### `--files-only`
@@ -476,6 +479,26 @@ Defaults to: `0`
 prerelease_offset = 1
 ```
 
+### `version_provider`
+
+Choose version provider
+
+* `pep` - default version provider.
+    - prerelease - `1.0.1a0`
+    - devrelease - `1.0.1dev0`
+    - dev and pre - `1.0.1a0.dev0`
+* `semver` - semver compatibly provider. Added "-" delimiter
+    - prerelease - `1.0.1-a0`
+    - devrelease - `1.0.1-dev0`
+    - dev and pre - `1.0.1-a0-dev0`
+
+Defaults to: `pep`
+
+```toml
+[tool.commitizen]
+version_provider = "semver"
+```
+
 ## Custom bump
 
 Read the [customizing section](./customization.md).