scm_provider.py

from __future__ import annotations

from packaging.version import InvalidVersion

from commitizen.git import get_tags
from commitizen.providers.base_provider import VersionProvider
from commitizen.tags import TagRules


class ScmProvider(VersionProvider):
    """
    A provider fetching the current/last version from the repository history

    The version is fetched using `git describe` and is never set.

    It is meant for `setuptools-scm` or any package manager `*-scm` provider.
    """

    def get_version(self) -> str:
        rules = TagRules.from_settings(self.config.settings)
        tags = get_tags(reachable_only=True)
        version_tags = rules.get_version_tags(tags)
        versions = []
        for t in version_tags:
            try:
                versions.append(rules.extract_version(t))
            except InvalidVersion:
                continue
        versions = sorted(versions)
        if not versions:
            return "0.0.0"
        return str(versions[-1])

    def set_version(self, version: str):
        # Not necessary
        pass