version.py

import argparse
import re
import subprocess
from typing import List, Tuple


class GitVersion:
    CI_FLAG = "[CI]"
    BRANCH_MAIN = "main"
    BRANCH_DEV = "development"
    ALLOWED_BRANCHES = BRANCH_MAIN, BRANCH_DEV

    @classmethod
    def sys_exec(cls, cmd: List[str]) -> None or str:
        try:
            out = subprocess.check_output(cmd).decode().strip()
        except subprocess.CalledProcessError:
            raise
        return out

    @classmethod
    def tag(cls, version: str, custom_version: str):
        if version is None:
            return
        version = custom_version or version

        print(f"Adding new tag {version}")
        cls.sys_exec(f"git tag -a {version} -m ".split() + [f" '{cls.CI_FLAG} - Version {version}'"])
        cls.sys_exec("git push origin --tags".split())

    @classmethod
    def get_branch(cls) -> str:
        return cls.sys_exec("git branch --show-current".split())

    @classmethod
    def get_version(cls) -> Tuple[str, str, str]:
        print("Getting version from last tag...")
        cls.sys_exec("python setup.py check".split())
        version = cls.sys_exec("git describe --abbrev=0".split())

        print(f"Found tag {version}")
        return re.compile(r"v(\d+)\.(\d+)\.(\d+)").findall(version).pop()  # major, minor, patch

    @classmethod
    def increment_version(cls, branch_name: str):
        major, minor, patch = cls.get_version()
        if branch_name == cls.BRANCH_MAIN:
            updated_patch = str(int(patch) + 1)
            updated_minor = minor
        elif branch_name == cls.BRANCH_DEV:
            print("Development branch - auto increment build number.")
            return None
        else:
            updated_patch = 0
            updated_minor = str(int(minor) + 1)

        version = f"v{major}.{updated_minor}.{updated_patch}"
        print(f"Version patch incremented by one v{major}.{minor}.{patch} -> {version}")
        return version

    @classmethod
    def update_branch(cls):
        try:
            cls.sys_exec("git fetch --prune --unshallow".split())
        except subprocess.CalledProcessError:
            pass

    @classmethod
    def main(cls, branch: str, custom_version: str):
        print("Starting versioning process...")
        branch_name = branch if branch else cls.get_branch()
        if branch_name not in cls.ALLOWED_BRANCHES and not branch_name.startswith("release"):
            print("Tag occur only on release or main branch")
            return

        print(f"Fetching git history ({branch_name})... ", end="")
        cls.update_branch()
        print("Done")

        cls.tag(cls.increment_version(branch_name), custom_version)
        print("Versioning process done!")


if __name__ == "__main__":
    parser = argparse.ArgumentParser("Version script")
    parser.add_argument("-b", "--branch", help="Branch name", type=str, default=None)
    parser.add_argument("-v", "--version", help="Custom version", type=str, default=None)
    args = parser.parse_args()

    GitVersion.main(args.branch, args.version)