Add extra validation for hotfix releases

Author: rvermeulen

.github/workflows/prepare-release.yml

@@ -11,6 +11,11 @@ on:
         description: |
           The git commit, branch, or tag to release from.
         required: true
+      hotfix:
+        description: |
+          Whether this is a hotfix release.
+        required: false
+        default: false
 
 permissions:
   contents: write
@@ -20,6 +25,7 @@ permissions:
 
 env:
   RELEASE_VERSION: ${{ inputs.version }}
+  HOTFIX_RELEASE: ${{ inputs.hotfix }}
 
 jobs:
   prepare-release:
@@ -34,6 +40,18 @@ jobs:
         with:
           ref: ${{ inputs.ref }}
 
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install release script dependencies
+        run: pip install -r scripts/release/requirements.txt
+
+      - name: Validate version
+        run: |
+          python scripts/release/validate-version.py "$RELEASE_VERSION"
+
       - name: Validate release precondition
         env:
           RELEASE_VERSION: ${{ inputs.version }}
@@ -84,18 +102,6 @@ jobs:
           git config user.name "$GITHUB_ACTOR"
           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
-      - name: Install Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.9"
-
-      - name: Install release script dependencies
-        run: pip install -r scripts/release/requirements.txt
-
-      - name: Validate version
-        run: |
-          python scripts/release/validate-version.py "$RELEASE_VERSION"
-
       - name: Create release branch
         run: |
           git switch -c rc/$RELEASE_VERSION

scripts/release/validate-version.py

@@ -1,20 +1,47 @@
 import semantic_version # type: ignore
-from typing import Literal
+from typing import Literal, TYPE_CHECKING
+from subprocess import run
 
-def main(args : list[str]) -> Literal[1, 0]:
-    if len(args) != 2:
-        print("Error: incorrect number of arguments", file=sys.stderr)
-        print(f"Usage: {args[0]} <version>", file=sys.stderr)
-        return 1
+if TYPE_CHECKING:
+    from argparse import Namespace
+
+def get_release_version_of_ref() -> semantic_version.Version:
+    cp = run(["git", "rev-parse", "--abbrev-ref", "HEAD"], capture_output=True, text=True)
+    if cp.returncode != 0:
+        raise RuntimeError("Failed to get current branch name")
+    branch_name = cp.stdout.strip()
+    ns, version_str = branch_name.split("/")
+    if ns != "rc":
+        raise RuntimeError("Not on a release branch!")
+    
+    try:
+        return semantic_version.Version(version_str) # type: ignore
+    except ValueError as e:
+        raise RuntimeError(f"Invalid version string: {e}")
 
+def main(args :'Namespace') -> Literal[1, 0]:
     try:
-        semantic_version.Version.parse(args[1]) # type: ignore
+        release_version = semantic_version.Version(args.version) # type: ignore
+        if args.hotfix:
+            branch_release_version = get_release_version_of_ref()
+            expected_version = branch_release_version.next_patch()
+            if release_version != expected_version:
+                print(f"Error: Hotfix version `{release_version}` does not iterate on {branch_release_version}. Expected `{expected_version}`. ", file=stderr)
+                return 1
         return 0
     except ValueError as e:
-        print(f"Error: invalid version: {e}", file=sys.stderr)
+        print(f"Error: invalid version: {e}", file=stderr)
+        return 1
+    except RuntimeError as e:
+        print(f"Error: {e}", file=stderr)
         return 1
-    
 
 if __name__ == '__main__':
-    import sys
-    sys.exit(main(sys.argv))
+    from sys import stderr, exit
+    import argparse
+
+    parser = argparse.ArgumentParser(description="Validate a version string")
+    parser.add_argument("version", help="The version string to validate")
+    parser.add_argument('--hotfix', action='store_true', help="Whether the release is to hotfix an existing release.")
+
+    exit(main(parser.parse_args()))