Fix clean up github action

Author: JeanRobin

.github/workflows/cleanup-dev-releases.yml

@@ -7,13 +7,37 @@ on:
         description: "Taipy version to clean up without extension. Ex: 3.2.1 cleans up all dev releases 3.2.1.devX"
         required: true
 
+      dry_run:
+        description: "Perform a dry run without actually deleting any releases (default: True)"
+        required: true
+        type: choice
+        options:
+          - True
+          - False
+        default: "True"
+
+      extension:
+        description: "Which extension to clean up. (default: dev)"
+        default: "dev"
+
 jobs:
   cleanup:
     runs-on: ubuntu-latest
     steps:
       - name: Display inputs
         run: |
           echo "Version: ${{ github.event.inputs.version }}"
+          echo "Dry run: ${{ github.event.inputs.dry_run }}"
+          echo "Extension: ${{ github.event.inputs.extension }}"
+
+      - name: Validate version
+        run: |
+          version="${{ github.event.inputs.target_version }}"
+          if [[ ! "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "❌ Invalid version format: '$version' - <M>.<m>.<p> is mandatory."
+            exit 1
+          fi
+          echo "✅ Valid target version: $version"
 
       - name: Install mandatory Python packages
         run: |
@@ -25,4 +49,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          python tools/release/cleanup_dev_releases.py
+          python tools/release/cleanup_dev_releases.py \
+            --version ${{ github.event.inputs.version }} \
+            --dry-run ${{ github.event.inputs.dry_run }} \
+            --extension ${{ github.event.inputs.extension }}

tests/tools/release/test_version.py

@@ -46,7 +46,7 @@ def test_from_string():
     assert version.ext == "some_ext.more_ext"
 
 
-def test_extension():
+def test_split_extension():
     version = Version.from_string("1.2.3")
     extension = version.split_ext()
     assert extension == ("", -1)
@@ -154,3 +154,30 @@ def test_order():
 
     versions = [Version(1, 0), Version(2, 1), Version(3, 4), Version(2, 0)]
     assert max(versions) == Version(3, 4), "Cannot find max in Version list"
+
+
+def test_has_extension():
+    version = Version.from_string("1.2.3")
+    assert not version.has_extension()
+
+    version = Version.from_string("1.2.3.dev")
+    assert version.has_extension()
+
+    version = Version.from_string("1.2.3.dev0")
+    assert version.has_extension()
+
+
+def test_validate_extension():
+    version = Version.from_string("1.2.3")
+    assert not version.validate_extension("dev")
+
+    version = Version.from_string("1.2.3.dev")
+    assert version.validate_extension("dev")
+    assert not version.validate_extension("rc")
+
+    version = Version.from_string("1.2.3.dev0")
+    assert version.validate_extension("dev")
+
+    version = Version.from_string("1.2.3.rc1")
+    assert version.validate_extension("rc")
+    assert not version.validate_extension("dev")

tools/release/cleanup_dev_releases.py

@@ -15,6 +15,7 @@
 import argparse
 
 import requests
+
 from common import Git, Version, fetch_github_releases
 
 
@@ -31,43 +32,93 @@ def main(arg_strings=None):
 The indicated version must not have extensions.""",
     )
 
+    parser.add_argument(
+        "--dry_run",
+        type=bool,
+        default="True",
+        help="A boolean flag indicating whether to perform a dry run (default: True). " +
+             "If set to True, the script will only print the releases and tags that would " +
+             "be deleted without actually deleting them. This can be useful for verifying " +
+             " which releases and tags would be affected before performing the actual deletion.")
+
+    parser.add_argument(
+        "--extension",
+        type=str,
+        default="dev",
+        help="The extension to look for in the releases to be deleted (default: 'dev'). ")
+
     args = parser.parse_args(arg_strings)
+    version = args.version
+    dry_run = args.dry_run
+    extension = args.extension
 
     github_path = Git.get_github_path()
     all_releases = fetch_github_releases(github_path)
-    found_dev_version_to_delete = False
+    found = []
+    found_wrong_version = []
+    found_wrong_extension = []
+    errors = []
     if all_releases:
         for package, releases in all_releases.items():
             for release in releases:
                 release_version: Version = release["version"]
-                release_id = release["id"]
-                release_tag = release["tag"]
-                if release_version.validate_extension() and args.version.match(release_version):
-                    pkg = package.name
-                    found_dev_version_to_delete = True
+                if release_version.has_extension():
+                    release_id = release["id"]
+                    release_tag = release["tag"]
+                    if version.matches(release_version) and release_version.validate_extension(ext=extension):
+                        found.append(release_id)
+                        if not __delete_release(dry_run, github_path, package.name, release_id, release_version):
+                            errors.append(f"Release {release_version}-{package.name} (id: {release_id})")
+                        if not __delete_tag(dry_run, github_path, release_tag):
+                            errors.append(f"Tag {release_tag}")
+                    elif not version.matches(release_version) and release_version.validate_extension(ext=extension):
+                        found_wrong_version.append(release_tag)
+                    elif version.matches(release_version) :
+                        found_wrong_extension.append(release_tag)
+    print()  # noqa: T201
+    if len(found) == 0:
+        print(f"No dev releases found for version {version}.")  # noqa: T201
+    else:
+        print(f"✅ Successfully deleted {len(found)} releases {version} with extension '{extension}'")  # noqa: T201
+    if len(errors) > 0:
+        print(f"❌ Failed to delete {len(errors)} items: {sorted(errors)}")  # noqa: T201
+    if len(found_wrong_extension) > 0:
+        print(f"Found {len(found_wrong_extension)} releases matching version {version} but with another extension:")  # noqa: T201
+        print(sorted(found_wrong_extension))  # noqa: T201
+    if len(found_wrong_version) > 0:
+        print(f"Found {len(found_wrong_version)} releases matching extension '{extension}' but with another version:") # noqa: T201
+        print(sorted(found_wrong_version)) # noqa: T201
 
-                    # Delete release
-                    url = f"https://api.github.com/repos/{github_path}/releases/{release_id}"
-                    response = requests.delete(url, headers={"Accept": "application/vnd.github+json"})
-                    if response.status_code == 204:
-                        print(f"✅ Successfully deleted '{pkg}-{release_version}'.")  # noqa: T201
-                    else:
-                        status = response.status_code
-                        txt = response.text
-                        print(f"❌ Failed to delete '{pkg}-{release_version}': {status} - {txt}")# noqa: T201
+def __delete_release(dry_run, github_path: str, pkg: str, release_id: str, release_version: Version) -> bool:
+    url = f"https://api.github.com/repos/{github_path}/releases/{release_id}"
+    if dry_run:
+        print(f'requests.delete("{url}", ' + # noqa: T201
+              'headers={"Accept": "application/vnd.github+json"})')  # noqa: T201
+        return True
+    else:
+        response = requests.delete(url, headers={"Accept": "application/vnd.github+json"})
+        if response.status_code == 204:
+            print(f"Successfully deleted '{pkg}-{release_version}'.")  # noqa: T201
+            return True
+        else:
+            print(f"❌ Failed to delete '{pkg}-{release_version}': {response.status_code} - {response.text}")  # noqa: T201
+            return False
 
-                    # Delete tag
-                    url = f"https://api.github.com/repos/{github_path}/git/refs/tags/{release_tag}'"
-                    response = requests.delete(url, headers={"Accept": "application/vnd.github+json"})
-                    if response.status_code == 204:
-                        print(f"✅ Successfully deleted tag {release_tag}.")  # noqa: T201
-                    else:
-                        status = response.status_code
-                        txt = response.text
-                        print(f"❌ Failed to delete tag {release_tag}: {status} - {txt}")  # noqa: T201
 
-    if not found_dev_version_to_delete:
-        print(f"No dev releases found for version {args.version}.")  # noqa: T201
+def __delete_tag(dry_run, github_path: str, release_tag: str) -> bool:
+    url = f"https://api.github.com/repos/{github_path}/git/refs/tags/{release_tag}"
+    if dry_run:
+        print(f'requests.delete("{url}", ' +  # noqa: T201
+              'headers={"Accept": "application/vnd.github+json"})')  # noqa: T201
+        return True
+    else:
+        response = requests.delete(url, headers={"Accept": "application/vnd.github+json"})
+        if response.status_code == 204:
+            print(f"Successfully deleted tag {release_tag}.")  # noqa: T201
+            return True
+        else:
+            print(f"❌ Failed to delete tag {release_tag}: {response.status_code} - {response.text}")  # noqa:
+            return False
 
 
 if __name__ == "__main__":

tools/release/common.py

@@ -100,6 +100,10 @@ def check_argument(value: str) -> "Version":
             raise argparse.ArgumentTypeError(f"'{value}' is not a valid version number.") from e
         return version
 
+    def has_extension(self) -> bool:
+        """Returns True if this Version has an extension part."""
+        return self.ext is not None
+
     def validate_extension(self, ext="dev"):
         """Returns True if the extension part of this Version is the one queried."""
         return self.split_ext()[0] == ext