ci: block the release if the version numbers is invalid (#2386)

Author: anakin87

.github/utils/validate_version.py

@@ -0,0 +1,58 @@
+import re
+import requests
+
+# * integrations/<INTEGRATION_FOLDER_NAME>-v1.0.0
+INTEGRATION_VERSION_REGEX = r"integrations/([a-zA-Z-]+)-v([0-9]\.[0-9]+\.[0-9]+)"
+
+
+def validate_version_number(tag: str):
+    """
+    Verify that a release version number follows semantic versioning rules by checking the latest version on PyPI.
+    """
+
+    matches = re.match(INTEGRATION_VERSION_REGEX, tag)
+    if not matches or len(matches.groups()) != 2:
+        raise ValueError(f"Invalid tag: {tag}")
+
+    integration_name, version_to_release = matches.groups()
+    print(f"Integration name: {integration_name}")
+    print(f"Integration version to release: {version_to_release}")
+
+    integration_package = f"{integration_name}-haystack"
+    print(f"Integration PyPi package: {integration_package}")
+
+    # connect to PyPi and check the latest version
+    try:
+        response = requests.get(f"https://pypi.org/pypi/{integration_package}/json")
+        response.raise_for_status()
+        latest_version = response.json()["info"]["version"]
+        print(f"Latest version on PyPI: {latest_version}")
+    except requests.exceptions.HTTPError as e:
+        if e.response.status_code == 404 and version_to_release in ["0.0.1", "0.1.0", "1.0.0"]:
+            print("Package not found on PyPI. Assuming this is the first release and skipping version check.")
+            return
+        raise e
+
+    x, y, z = [int(i) for i in latest_version.split(".")]
+
+    acceptable_new_versions = [
+        f"{x}.{y}.{z + 1}",
+        f"{x}.{y + 1}.0",
+        f"{x + 1}.0.0",
+    ]
+    if version_to_release not in acceptable_new_versions:
+        msg = (
+            f"Invalid version to release: {version_to_release}. Acceptable new versions are: {acceptable_new_versions}"
+        )
+        raise ValueError(msg)
+    print("The version to release is acceptable.")
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--tag", help="Git tag in format 'integrations/<name>-v<version>'", required=True, type=str)
+    args = parser.parse_args()
+
+    validate_version_number(args.tag)

.github/workflows/CI_pypi_release.yml

@@ -24,8 +24,11 @@ jobs:
           token: ${{ secrets.HAYSTACK_BOT_TOKEN }}
           fetch-depth: 0
 
-      - name: Install Hatch
-        run: pip install hatch
+      - name: Install dependencies
+        run: pip install hatch requests
+
+      - name: Validate version number
+        run: python .github/utils/validate_version.py --tag ${{ github.ref_name }}
 
       - name: Get project folder
         id: pathfinder