Merge branch 'v3' into version_provider

Author: Apkawa

.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/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,5 @@ venv.bak/
 .vscode/
 *.bak
 
-# build
-poetry.lock
-
 # macOSX
 .DS_Store

commitizen/changelog.py

@@ -34,6 +34,7 @@
 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
@@ -51,6 +52,31 @@ 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],
@@ -59,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)
@@ -81,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)

commitizen/cli.py

@@ -2,6 +2,7 @@
 import logging
 import sys
 from functools import partial
+from types import TracebackType
 from typing import List
 
 import argcomplete
@@ -253,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"
+                        ),
+                    },
                 ],
             },
             {
@@ -336,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)

commitizen/commands/bump.py

@@ -21,6 +21,7 @@
     NotAllowed,
     NoVersionSpecifiedError,
 )
+from commitizen.providers import get_provider
 
 logger = getLogger("commitizen")
 
@@ -98,14 +99,14 @@ def find_increment(self, commits: List[git.GitCommit]) -> Optional[str]:
 
     def __call__(self):  # noqa: C901
         """Steps executed to bump."""
+        provider = get_provider(self.config)
+        current_version: str = provider.get_version()
+
         try:
-            current_version_instance: Version = Version(self.bump_settings["version"])
+            current_version_instance: Version = Version(current_version)
         except TypeError:
             raise NoVersionSpecifiedError()
 
-        # Initialize values from sources (conf)
-        current_version: str = self.config.settings["version"]
-
         tag_format: str = self.bump_settings["tag_format"]
         bump_commit_message: str = self.bump_settings["bump_message"]
         version_files: List[str] = self.bump_settings["version_files"]
@@ -291,7 +292,7 @@ def __call__(self):  # noqa: C901
             check_consistency=self.check_consistency,
         )
 
-        self.config.set_key("version", str(new_version))
+        provider.set_version(str(new_version))
 
         if self.pre_bump_hooks:
             hooks.run(

commitizen/commands/changelog.py

@@ -49,6 +49,9 @@ def __init__(self, config: BaseConfig, args):
         self.tag_format = args.get("tag_format") or self.config.settings.get(
             "tag_format"
         )
+        self.merge_prerelease = args.get(
+            "merge_prerelease"
+        ) or self.config.settings.get("changelog_merge_prerelease")
 
         version_type = self.config.settings.get("version_type")
         self.version_type = version_type and version_types.VERSION_TYPES[version_type]
@@ -113,6 +116,7 @@ def __call__(self):
         changelog_message_builder_hook: Optional[
             Callable
         ] = self.cz.changelog_message_builder_hook
+        merge_prerelease = self.merge_prerelease
 
         if not changelog_pattern or not commit_parser:
             raise NoPatternMapError(
@@ -150,9 +154,7 @@ def __call__(self):
                 version_type_cls=self.version_type,
             )
 
-        commits = git.get_commits(
-            start=start_rev, end=end_rev, args="--author-date-order"
-        )
+        commits = git.get_commits(start=start_rev, end=end_rev, args="--topo-order")
         if not commits:
             raise NoCommitsFoundError("No commits found")
 
@@ -164,6 +166,7 @@ def __call__(self):
             unreleased_version,
             change_type_map=change_type_map,
             changelog_message_builder_hook=changelog_message_builder_hook,
+            merge_prerelease=merge_prerelease,
         )
         if self.change_type_order:
             tree = changelog.order_changelog_tree(tree, self.change_type_order)

commitizen/commands/version.py

@@ -4,6 +4,7 @@
 from commitizen import out
 from commitizen.__version__ import __version__
 from commitizen.config import BaseConfig
+from commitizen.providers import get_provider
 
 
 class Version:
@@ -21,14 +22,14 @@ def __call__(self):
             out.write(f"Python Version: {self.python_version}")
             out.write(f"Operating System: {self.operating_system}")
         elif self.parameter.get("project"):
-            version = self.config.settings["version"]
+            version = get_provider(self.config).get_version()
             if version:
                 out.write(f"{version}")
             else:
                 out.error("No project information in this project.")
         elif self.parameter.get("verbose"):
             out.write(f"Installed Commitizen Version: {__version__}")
-            version = self.config.settings["version"]
+            version = get_provider(self.config).get_version()
             if version:
                 out.write(f"Project Version: {version}")
             else:

commitizen/cz/__init__.py

@@ -1,15 +1,18 @@
+from __future__ import annotations
+
 import importlib
 import pkgutil
 import warnings
-from typing import Dict, Iterable, Type
+from typing import Iterable, Optional
+
+import importlib_metadata as metadata
 
 from commitizen.cz.base import BaseCommitizen
-from commitizen.cz.conventional_commits import ConventionalCommitsCz
-from commitizen.cz.customize import CustomizeCommitsCz
-from commitizen.cz.jira import JiraSmartCz
 
 
-def discover_plugins(path: Iterable[str] = None) -> Dict[str, Type[BaseCommitizen]]:
+def discover_plugins(
+    path: Optional[Iterable[str]] = None,
+) -> dict[str, type[BaseCommitizen]]:
     """Discover commitizen plugins on the path
 
     Args:
@@ -19,21 +22,19 @@ def discover_plugins(path: Iterable[str] = None) -> Dict[str, Type[BaseCommitize
     Returns:
         Dict[str, Type[BaseCommitizen]]: Registry with found plugins
     """
-    plugins = {}
-    for _finder, name, _ispkg in pkgutil.iter_modules(path):
-        try:
-            if name.startswith("cz_"):
-                plugins[name] = importlib.import_module(name).discover_this
-        except AttributeError as e:
-            warnings.warn(UserWarning(e.args[0]))
-            continue
-    return plugins
-
-
-registry: Dict[str, Type[BaseCommitizen]] = {
-    "cz_conventional_commits": ConventionalCommitsCz,
-    "cz_jira": JiraSmartCz,
-    "cz_customize": CustomizeCommitsCz,
-}
-
-registry.update(discover_plugins())
+    for _, name, _ in pkgutil.iter_modules(path):
+        if name.startswith("cz_"):
+            mod = importlib.import_module(name)
+            if hasattr(mod, "discover_this"):
+                warnings.warn(
+                    UserWarning(
+                        f"Legacy plugin '{name}' has been ignored: please expose it the 'commitizen.plugin' entrypoint"
+                    )
+                )
+
+    return {
+        ep.name: ep.load() for ep in metadata.entry_points(group="commitizen.plugin")
+    }
+
+
+registry: dict[str, type[BaseCommitizen]] = discover_plugins()

commitizen/defaults.py

@@ -29,12 +29,14 @@ class Settings(TypedDict, total=False):
     name: str
     version: Optional[str]
     version_files: List[str]
+    version_provider: Optional[str]
     tag_format: Optional[str]
     bump_message: Optional[str]
     allow_abort: bool
     changelog_file: str
     changelog_incremental: bool
     changelog_start_rev: Optional[str]
+    changelog_merge_prerelease: bool
     update_changelog_on_bump: bool
     use_shortcuts: bool
     style: Optional[List[Tuple[str, str]]]
@@ -60,12 +62,14 @@ class Settings(TypedDict, total=False):
     "name": "cz_conventional_commits",
     "version": None,
     "version_files": [],
+    "version_provider": "commitizen",
     "tag_format": None,  # example v$version
     "bump_message": None,  # bumped v$current_version to $new_version
     "allow_abort": False,
     "changelog_file": "CHANGELOG.md",
     "changelog_incremental": False,
     "changelog_start_rev": None,
+    "changelog_merge_prerelease": False,
     "update_changelog_on_bump": False,
     "use_shortcuts": False,
     "major_version_zero": False,

commitizen/exceptions.py

@@ -31,6 +31,7 @@ class ExitCode(enum.IntEnum):
     INVALID_MANUAL_VERSION = 24
     INIT_FAILED = 25
     RUN_HOOK_FAILED = 26
+    VERSION_PROVIDER_UNKNOWN = 27
 
 
 class CommitizenException(Exception):
@@ -173,3 +174,7 @@ class InitFailedError(CommitizenException):
 
 class RunHookError(CommitizenException):
     exit_code = ExitCode.RUN_HOOK_FAILED
+
+
+class VersionProviderUnknown(CommitizenException):
+    exit_code = ExitCode.VERSION_PROVIDER_UNKNOWN