Merge pull request #715 from commitizen-tools/v3

Release v3

Author: woile

.github/dependabot.yml

@@ -0,0 +1,24 @@
+version: 2
+updates:
+  -
+    # Maintain dependencies for GitHub Actions
+    package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+    labels:
+      - dependencies
+    commit-message:
+      prefix: "ci(actions)"
+      include: "scope"
+  -
+    # Maintain python dependencies
+    package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: daily
+    labels:
+      - dependencies
+    commit-message:
+      prefix: "build(poetry)"
+      include: "scope"

.github/workflows/bumpversion.yml

@@ -20,3 +20,11 @@ jobs:
         uses: commitizen-tools/commitizen-action@master
         with:
           github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          changelog_increment_filename: body.md
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: "body.md"
+          tag_name: ${{ env.REVISION }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pythonpackage.yml

@@ -6,7 +6,7 @@ jobs:
   python-check:
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
         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@v1.0.3
+      uses: codecov/codecov-action@v3
       with:
         token: ${{secrets.CODECOV_TOKEN}}
         file: ./coverage.xml

.gitignore

@@ -108,8 +108,8 @@ venv.bak/
 .vscode/
 *.bak
 
-# build
-poetry.lock
-
 # macOSX
 .DS_Store
+
+# ruff
+.ruff_cache

commitizen/bump.py

@@ -1,16 +1,24 @@
 import os
 import re
+import sys
+import typing
 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
 
 from commitizen.defaults import MAJOR, MINOR, PATCH, bump_message
 from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit, smart_open
 
+if sys.version_info >= (3, 8):
+    from commitizen.version_types import VersionProtocol
+else:
+    # workaround mypy issue for 3.7 python
+    VersionProtocol = typing.Any
+
 
 def find_increment(
     commits: List[GitCommit], regex: str, increments_map: Union[dict, OrderedDict]
@@ -120,7 +128,8 @@ def generate_version(
     prerelease_offset: int = 0,
     devrelease: Optional[int] = None,
     is_local_version: bool = False,
-) -> Version:
+    version_type_cls: Optional[Type[VersionProtocol]] = None,
+) -> VersionProtocol:
     """Based on the given increment a proper semver will be generated.
 
     For now the rules and versioning scheme is based on
@@ -132,15 +141,17 @@ def generate_version(
         MINOR 1.0.0 -> 1.1.0
         MAJOR 1.0.0 -> 2.0.0
     """
+    if version_type_cls is None:
+        version_type_cls = Version
     if is_local_version:
-        version = Version(current_version)
+        version = version_type_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_type_cls(f"{version.public}+{semver}{pre_version}{dev_version}")
     else:
         dev_version = devrelease_generator(devrelease=devrelease)
         pre_version = prerelease_generator(
@@ -149,7 +160,7 @@ def generate_version(
         semver = semver_generator(current_version, increment=increment)
 
         # TODO: post version
-        return Version(f"{semver}{pre_version}{dev_version}")
+        return version_type_cls(f"{semver}{pre_version}{dev_version}")
 
 
 def update_version_in_files(
@@ -208,7 +219,9 @@ def _version_to_regex(version: str) -> str:
 
 
 def normalize_tag(
-    version: Union[Version, str], tag_format: Optional[str] = None
+    version: Union[VersionProtocol, str],
+    tag_format: Optional[str] = None,
+    version_type_cls: Optional[Type[VersionProtocol]] = None,
 ) -> str:
     """The tag and the software version might be different.
 
@@ -221,8 +234,10 @@ def normalize_tag(
     | ver1.0.0 | 1.0.0 |
     | ver1.0.0.a0 | 1.0.0a0 |
     """
+    if version_type_cls is None:
+        version_type_cls = Version
     if isinstance(version, str):
-        version = Version(version)
+        version = version_type_cls(version)
 
     if not tag_format:
         return str(version)

commitizen/changelog.py

@@ -27,22 +27,56 @@
 
 import os
 import re
+import sys
+import typing
 from collections import OrderedDict, defaultdict
 from datetime import date
-from typing import Callable, Dict, Iterable, List, Optional, Tuple
+from typing import Callable, Dict, Iterable, List, Optional, Tuple, Type
 
 from jinja2 import Environment, PackageLoader
+from packaging.version import InvalidVersion, Version
 
 from commitizen import defaults
 from commitizen.bump import normalize_tag
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
 
+if sys.version_info >= (3, 8):
+    from commitizen.version_types import VersionProtocol
+else:
+    # workaround mypy issue for 3.7 python
+    VersionProtocol = typing.Any
+
 
 def get_commit_tag(commit: GitCommit, tags: List[GitTag]) -> Optional[GitTag]:
     return next((tag for tag in tags if tag.rev == commit.rev), None)
 
 
+def get_version(tag: GitTag) -> Optional[Version]:
+    version = None
+    try:
+        version = Version(tag.name)
+    except InvalidVersion:
+        pass
+    return version
+
+
+def tag_included_in_changelog(
+    tag: GitTag, used_tags: List, merge_prerelease: bool
+) -> bool:
+    if tag in used_tags:
+        return False
+
+    version = get_version(tag)
+    if version is None:
+        return False
+
+    if merge_prerelease and version.is_prerelease:
+        return False
+
+    return True
+
+
 def generate_tree_from_commits(
     commits: List[GitCommit],
     tags: List[GitTag],
@@ -51,6 +85,7 @@ def generate_tree_from_commits(
     unreleased_version: Optional[str] = None,
     change_type_map: Optional[Dict[str, str]] = None,
     changelog_message_builder_hook: Optional[Callable] = None,
+    merge_prerelease: bool = False,
 ) -> Iterable[Dict]:
     pat = re.compile(changelog_pattern)
     map_pat = re.compile(commit_parser, re.MULTILINE)
@@ -73,15 +108,15 @@ def generate_tree_from_commits(
     for commit in commits:
         commit_tag = get_commit_tag(commit, tags)
 
-        if commit_tag is not None and commit_tag not in used_tags:
+        if commit_tag is not None and tag_included_in_changelog(
+            commit_tag, used_tags, merge_prerelease
+        ):
             used_tags.append(commit_tag)
             yield {
                 "version": current_tag_name,
                 "date": current_tag_date,
                 "changes": changes,
             }
-            # TODO: Check if tag matches the version pattern, otherwise skip it.
-            # This in order to prevent tags that are not versions.
             current_tag_name = commit_tag.name
             current_tag_date = commit_tag.date
             changes = defaultdict(list)
@@ -286,7 +321,10 @@ def get_smart_tag_range(
 
 
 def get_oldest_and_newest_rev(
-    tags: List[GitTag], version: str, tag_format: str
+    tags: List[GitTag],
+    version: str,
+    tag_format: str,
+    version_type_cls: Optional[Type[VersionProtocol]] = None,
 ) -> Tuple[Optional[str], Optional[str]]:
     """Find the tags for the given version.
 
@@ -301,11 +339,15 @@ def get_oldest_and_newest_rev(
     except ValueError:
         newest = version
 
-    newest_tag = normalize_tag(newest, tag_format=tag_format)
+    newest_tag = normalize_tag(
+        newest, tag_format=tag_format, version_type_cls=version_type_cls
+    )
 
     oldest_tag = None
     if oldest:
-        oldest_tag = normalize_tag(oldest, tag_format=tag_format)
+        oldest_tag = normalize_tag(
+            oldest, tag_format=tag_format, version_type_cls=version_type_cls
+        )
 
     tags_range = get_smart_tag_range(tags, newest=newest_tag, oldest=oldest_tag)
     if not tags_range:

commitizen/cli.py

@@ -2,12 +2,13 @@
 import logging
 import sys
 from functools import partial
+from types import TracebackType
 from typing import List
 
 import argcomplete
 from decli import cli
 
-from commitizen import commands, config, out
+from commitizen import commands, config, out, version_types
 from commitizen.exceptions import (
     CommitizenException,
     ExitCode,
@@ -202,6 +203,12 @@
                         "help": "bump to the given version (e.g: 1.5.3)",
                         "metavar": "MANUAL_VERSION",
                     },
+                    {
+                        "name": ["--version-type"],
+                        "help": "choose version type",
+                        "default": None,
+                        "choices": version_types.VERSION_TYPES,
+                    },
                 ],
             },
             {
@@ -247,10 +254,19 @@
                         "name": "--start-rev",
                         "default": None,
                         "help": (
-                            "start rev of the changelog."
+                            "start rev of the changelog. "
                             "If not set, it will generate changelog from the start"
                         ),
                     },
+                    {
+                        "name": "--merge-prerelease",
+                        "action": "store_true",
+                        "default": False,
+                        "help": (
+                            "collect all changes from prereleases into next non-prerelease. "
+                            "If not set, it will include prereleases in the changelog"
+                        ),
+                    },
                 ],
             },
             {
@@ -330,21 +346,22 @@
 
 
 def commitizen_excepthook(
-    type, value, tracekback, debug=False, no_raise: List[int] = None
+    type, value, traceback, debug=False, no_raise: List[int] = None
 ):
+    traceback = traceback if isinstance(traceback, TracebackType) else None
     if not no_raise:
         no_raise = []
     if isinstance(value, CommitizenException):
         if value.message:
             value.output_method(value.message)
         if debug:
-            original_excepthook(type, value, tracekback)
+            original_excepthook(type, value, traceback)
         exit_code = value.exit_code
         if exit_code in no_raise:
             exit_code = 0
         sys.exit(exit_code)
     else:
-        original_excepthook(type, value, tracekback)
+        original_excepthook(type, value, traceback)
 
 
 commitizen_debug_excepthook = partial(commitizen_excepthook, debug=True)