Add Nox task for triggering the release and function to release by a release type

Author: Jannis-Mittenzwei

exasol/toolbox/nox/_release.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import argparse
+import sys
 from pathlib import Path
 from typing import (
     List,
@@ -24,18 +25,31 @@
     new_unreleased,
 )
 from noxconfig import PROJECT_CONFIG
-
+from enum import Enum
+import subprocess
+import re
 
 def _create_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         prog="nox -s release:prepare",
-        usage="nox -s release:prepare -- [-h] version",
+        usage="nox -s release:experimental -- [-h] [-v | --version VERSION] [-t | --type {major,minor,patch}]",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
-    parser.add_argument(
-        "version",
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument(
+        "-v", "--version",
         type=cli.version,
-        help=("A version string of the following format:" '"NUMBER.NUMBER.NUMBER"'),
+        help="A version string of the following format:" '"NUMBER.NUMBER.NUMBER"',
+        required=False,
+        default=argparse.SUPPRESS
+    )
+    group.add_argument(
+        "-t", "--type",
+        type=ReleaseTypes,
+        help="specifies which type of upgrade is to be performed",
+        required=False,
+        choices=[rt.value for rt in list(ReleaseTypes)],
+        default=argparse.SUPPRESS
     )
     parser.add_argument(
         "--no-add",
@@ -89,6 +103,42 @@ def _add_files_to_index(session: Session, files: list[Path]) -> None:
         session.run("git", "add", f"{file}")
 
 
+class ReleaseTypes(Enum):
+    Major = "major"
+    Minor = "minor"
+    Patch = "patch"
+
+
+def _type_release(release_type: ReleaseTypes, old_version: Version) -> Version:
+    upgrade = {
+        ReleaseTypes.Major: Version(old_version.major + 1, 0, 0),
+        ReleaseTypes.Minor: Version(old_version.major, old_version.minor + 1, 0),
+        ReleaseTypes.Patch: Version(old_version.major, old_version.minor, old_version.patch + 1),
+    }
+    return upgrade[release_type]
+
+
+def _version_control(session: Session, args: argparse.Namespace,) -> Version:
+    has_release_version = hasattr(args, "version")
+    has_release_type = hasattr(args, "type")
+
+    old_version = Version.from_poetry()
+
+    if has_release_version and has_release_type:
+        session.error("choose either a release version or a release type")
+
+    if has_release_version and not has_release_type:
+        if not _is_valid_version(old=old_version, new=args.version):
+            session.error(
+                f"Invalid version: the release version ({args.version}) "
+                f"must be greater than or equal to the current version ({args.version})"
+            )
+        return args.version
+
+    if not has_release_version and has_release_type:
+        return _type_release(release_type=args.type, old_version=old_version)
+
+
 @nox.session(name="release:prepare", python=False)
 def prepare_release(session: Session, python=False) -> None:
     """
@@ -97,14 +147,7 @@ def prepare_release(session: Session, python=False) -> None:
     parser = _create_parser()
     args = parser.parse_args(session.posargs)
 
-    if not _is_valid_version(
-        old=(old_version := Version.from_poetry()),
-        new=(new_version := args.version),
-    ):
-        session.error(
-            f"Invalid version: the release version ({new_version}) "
-            f"must be greater than or equal to the current version ({old_version})"
-        )
+    new_version = _version_control(session, args)
 
     if not args.no_branch and not args.no_add:
         session.run("git", "switch", "-c", f"release/prepare-{new_version}")
@@ -146,3 +189,47 @@ def prepare_release(session: Session, python=False) -> None:
             "--body",
             '""',
         )
+
+
+@nox.session(name="release:trigger", python=False)
+def release(session: Session) -> None:
+
+    parser = argparse.ArgumentParser(
+        prog="nox -s release:experimental",
+        usage="nox -s release:experimental -- [-h] [-v | --version VERSION] [-t | --type {major,minor,patch}]",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument(
+        "-v", "--version",
+        type=cli.version,
+        help="A version string of the following format:" '"NUMBER.NUMBER.NUMBER"',
+        default=argparse.SUPPRESS
+    )
+    group.add_argument(
+        "-t", "--type",
+        type=ReleaseTypes,
+        help="specifies which type of upgrade is to be performed",
+        choices=list(ReleaseTypes),
+        default=argparse.SUPPRESS
+    )
+
+    args = parser.parse_args(session.posargs)
+
+    new_version = _version_control(session, args)
+    print(str(new_version))
+
+    result = subprocess.run(["git", "remote", "show", "origin"], capture_output=True)
+    match = re.search(r"HEAD branch: (\S+)", result.stdout.decode("utf-8"))
+    if not match:
+        session.error("Default branch could not be found")
+    default_branch = match.group(1) if match else None
+    subprocess.run(["git", "checkout", default_branch])
+    subprocess.run(["git", "pull"])
+    key = False
+    if not key:
+        return
+    print(":(")
+    subprocess.run(["git", "tag", str(new_version)])
+    subprocess.run(["git", "push", "origin", str(new_version)])
+    pass

test/unit/release_test.py

@@ -10,8 +10,10 @@
     extract_release_notes,
     new_changelog,
 )
-
-
+from exasol.toolbox.nox._release import (
+    ReleaseTypes,
+    _type_release
+)
 @pytest.mark.parametrize(
     "input,expected",
     [
@@ -143,3 +145,16 @@ def test_extract_release_notes(unreleased_md):
     )
     actual = extract_release_notes(unreleased_md)
     assert expected == actual
+
+
+@pytest.mark.parametrize(
+    "rtype,old,expected",[
+        ("major", "1.2.3", "2.0.0"),
+        ("minor", "1.2.3", "1.3.0"),
+        ("patch", "1.2.3", "1.2.4"),
+    ]
+)
+def test_type_release(rtype, old, expected):
+    actual = _type_release(ReleaseTypes(rtype), Version.from_string(old))
+    expected = Version.from_string(expected)
+    assert actual == expected