Merge pull request #713 from zapta/develop

cavearr · web-flow · commit 268c3329a421 · 2025-12-02T18:46:27.000+01:00
Simplified the remote config file format
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,9 @@
 {
+    "files.exclude": {
+        ".tox": true,
+        ".pytest_cache": true,
+        "**/__pycache__": true,
+    },
     "python.testing.pytestArgs": [
         "test"
     ],
@@ -61,12 +66,14 @@
         "FGPA",
         "fomu",
         "fpgas",
+        "fpgawars",
         "ftdi",
         "FTDIUSB",
         "Fumo",
         "GENCODE",
         "González",
         "gowin",
+        "graphviz",
         "gtkwave",
         "helpfull",
         "htmlcov",
@@ -153,4 +160,4 @@
         "yosys",
         "Zadig"
     ]
-}
+}
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
-[![][apio-logo]][wiki]
+![][apio-logo]
 
 [![License][license-image]][license-url]
-[![apio-test](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)]()
+[![python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://github.com/FPGAwars/apio)
+[![](https://img.shields.io/badge/VS%20Code-compatible-blue?logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=FPGAwars.apio)
 
 [![apio-test](https://img.shields.io/github/actions/workflow/status/fpgawars/apio/test.yaml?label=apio-test)](https://github.com/fpgawars/apio/actions/workflows/test.yaml)
 [![apio-dev-build](https://img.shields.io/github/actions/workflow/status/fpgawars/apio-dev-builds/build-and-release.yaml?label=apio-dev-build)](https://github.com/fpgawars/apio-dev-builds/actions/workflows/build-and-release.yaml)
diff --git a/apio/__init__.py b/apio/__init__.py
@@ -11,7 +11,7 @@
 # --------------------------------------------
 
 # -- Developer: Change this number when releasing a new version
-VERSION = (1, 0, 1)
+VERSION = (1, 0, 2)
 
 # -- Get the version as a string. Ex: "0.10.1"
 __version__ = ".".join([str(s) for s in VERSION])
diff --git a/apio/managers/packages.py b/apio/managers/packages.py
@@ -50,28 +50,14 @@ def __post_init__(self):
 
 def _construct_package_download_url(
     packages_ctx: PackagesContext,
-    target_version: str,
     package_remote_config: PackageRemoteConfig,
 ) -> str:
     """Construct the download URL for the given package name and version."""
 
-    # -- Convert the version to "YYYY-MM-DD"
-    # -- Move to a function in util.py.
-    version_tokens = target_version.split(".")
-    assert len(version_tokens) == 3, version_tokens
-    yyyy_mm_dd = (
-        f"{int(version_tokens[0]):04d}"
-        + "-"
-        + f"{int(version_tokens[1]):02d}"
-        + "-"
-        + f"{int(version_tokens[2]):02d}"
-    )
-
     # -- Create vars mapping.
     url_vars = {
         "${PLATFORM}": packages_ctx.platform_id,
-        "${YYYY-MM-DD}": yyyy_mm_dd,
-        "${YYYYMMDD}": yyyy_mm_dd.replace("-", ""),
+        "${YYYYMMDD}": package_remote_config.release_tag.replace("-", ""),
     }
     if util.is_debug(1):
         cout(f"Package URL vars: {url_vars}")
@@ -91,7 +77,7 @@ def _construct_package_download_url(
     if util.is_debug(1):
         cout(f"package url parts = {url_parts}")
 
-    # -- Concatanate the URL parts.
+    # -- Concatenate the URL parts.
     url = "".join(url_parts)
 
     if util.is_debug(1):
@@ -338,7 +324,7 @@ def install_package(
 
     # -- Construct the download URL.
     download_url = _construct_package_download_url(
-        packages_ctx, target_version, package_config
+        packages_ctx, package_config
     )
     if verbose:
         cout(f"Download URL: {download_url}")
diff --git a/apio/profile.py b/apio/profile.py
@@ -50,20 +50,17 @@
                         "release": {
                             "type": "object",
                             "required": [
-                                "version",
-                                "release-tag",
-                                "package-file",
+                                "tag",
+                                "package",
                             ],
                             "properties": {
-                                # -- Version
-                                "version": {
+                                # -- Tag
+                                "tag": {
                                     "type": "string",
-                                    "pattern": r"^\d{4}\.\d{2}\.\d{2}$",
+                                    "pattern": r"^\d{4}\-\d{2}\-\d{2}$",
                                 },
-                                # -- Release tag
-                                "release-tag": {"type": "string"},
-                                # -- Package file
-                                "package-file": {"type": "string"},
+                                # -- Package
+                                "package": {"type": "string"},
                             },
                             "additionalProperties": False,
                         },
@@ -407,9 +404,9 @@ def get_package_config(
         package_config = self.remote_config["packages"][package_name]
         repo_name = package_config["repository"]["name"]
         repo_organization = package_config["repository"]["organization"]
-        release_version = package_config["release"]["version"]
-        release_tag = package_config["release"]["release-tag"]
-        release_file = package_config["release"]["package-file"]
+        release_tag = package_config["release"]["tag"]
+        release_version = release_tag.replace("-", ".")
+        release_file = package_config["release"]["package"]
 
         return PackageRemoteConfig(
             repo_name=repo_name,
diff --git a/apio/resources/config.jsonc b/apio/resources/config.jsonc
@@ -20,6 +20,9 @@
   // The value of the remote config field here can be overridden for testing
   // using the env var APIO_REMOTE_CONFIG_URL, including for reading from
   // a local file using the "file://" protocol spec.
+  //
+  // For testing using the remote config at zapta:
+  // export APIO_REMOTE_CONFIG_URL="https://github.com/zapta/apio/raw/develop/remote-config/apio-{V}.jsonc"
 
   "remote-config-url": "https://github.com/fpgawars/apio/raw/develop/remote-config/apio-{V}.jsonc"
 }
diff --git a/remote-config/apio-1.0.2.jsonc b/remote-config/apio-1.0.2.jsonc
@@ -0,0 +1,79 @@
+// Remote config file for Apio 1.0.2
+//
+// Supported vars (see installer.py for details):
+//
+//   ${PLATFORM}         - platform id (from platforms.jsonc)
+//   ${YYYYMMDD}         - the YYYY-MM_DD tag converted to YYYYMMDD
+//
+// NOTE: Github has a cache propagation of about 1 min between the
+// time this file is submitted and until it's available for download.
+{
+  "packages": {
+    // -- Definitions package
+    "definitions": {
+      "repository": {
+        "organization": "fpgawars",
+        "name": "apio-definitions"
+      },
+      "release": {
+        "tag": "2025-10-20",
+        "package": "apio-definitions-${YYYYMMDD}.tgz"
+      }
+    },
+    // -- Examples package
+    "examples": {
+      "repository": {
+        "organization": "fpgawars",
+        "name": "apio-examples"
+      },
+      "release": {
+        "tag": "2025-12-01",
+        "package": "apio-examples-${YYYYMMDD}.tgz"
+      }
+    },
+    // -- OSS Cad Suite package (Yosys)
+    "oss-cad-suite": {
+      "repository": {
+        "organization": "fpgawars",
+        "name": "tools-oss-cad-suite"
+      },
+      "release": {
+        "tag": "2025-09-24",
+        "package": "apio-oss-cad-suite-${PLATFORM}-${YYYYMMDD}.tgz"
+      }
+    },
+    // -- Graphviz package
+    "graphviz": {
+      "repository": {
+        "organization": "fpgawars",
+        "name": "tools-graphviz"
+      },
+      "release": {
+        "tag": "2025-06-13",
+        "package": "apio-graphviz-${PLATFORM}-${YYYYMMDD}.tgz"
+      }
+    },
+    // -- Verible package
+    "verible": {
+      "repository": {
+        "organization": "fpgawars",
+        "name": "tools-verible"
+      },
+      "release": {
+        "tag": "2025-06-13",
+        "package": "apio-verible-${PLATFORM}-${YYYYMMDD}.tgz"
+      }
+    },
+    // -- Drivers package
+    "drivers": {
+      "repository": {
+        "organization": "fpgawars",
+        "name": "tools-drivers"
+      },
+      "release": {
+        "tag": "2025-06-13",
+        "package": "apio-drivers-${PLATFORM}-${YYYYMMDD}.tgz"
+      }
+    }
+  }
+}
diff --git a/scripts/genereate-repo-cleaner.sh b/scripts/genereate-repo-cleaner.sh
@@ -38,8 +38,14 @@ delete_tag() {
   gh api --method DELETE "/repos/\$REPO/git/refs/tags/\$tag" --silent 2>/dev/null || echo "  → Tag already gone or not found"
 }
 
+delete_release_and_tag() {
+  local tag="\$1"
+  delete_release "\$tag"
+  delete_tag "\$tag"
+}
+
 echo "DRY RUN — No deletions will happen until you uncomment the lines below"
-echo "Repo: \$REPO"
+echo "Repo: $REPO"
 echo "========================================================================"
 echo
 echo "# 1. Releases + their tags (release first, then tag)"
@@ -52,7 +58,7 @@ gh release list --repo "$REPO" --limit 1000 --json tagName -q '.[].tagName' |
   sort -V |
   while read -r tag; do
     [[ -n "$tag" ]] || continue
-    echo "# delete_release \"$tag\"; delete_tag \"$tag\""
+    echo "# delete_release_and_tag  \"$tag\""
   done
 
 # Step 2: All tags that are NOT attached to any release
@@ -69,7 +75,7 @@ comm -23 \
   <(gh api "repos/$REPO/tags?per_page=100" --paginate --jq '.[].name' | sort -u) \
   <(gh release list --repo "$REPO" --limit 1000 --json tagName -q '.[].tagName' | sort -u) |
   while read -r tag; do
-    [[ -n "$tag" ]] && echo "# delete_tag \"$tag\""
+    [[ -n "$tag" ]] && echo "# delete_tag  \"$tag\""
   done
 
 cat <<'EOF'
diff --git a/tests/unit_tests/test_profile.py b/tests/unit_tests/test_profile.py
@@ -19,13 +19,6 @@
 )
 
 
-def get_remote_config_url(apio_ctx: ApioContext) -> str:
-    """Returns a test remote config URL."""
-    url = apio_ctx.config["remote-config-url"]
-    url = url.replace("{V}", util.get_apio_version())
-    return url
-
-
 def get_test_data(
     apio_ctx: ApioContext,
     loaded_by_apio_version: str,
@@ -43,7 +36,7 @@ def get_test_data(
             "metadata": {
                 "loaded-at": loaded_at_stamp,
                 "loaded-by": loaded_by_apio_version,
-                "loaded-from": get_remote_config_url(apio_ctx),
+                "loaded-from": apio_ctx.profile.remote_config_url,
             },
             "packages": {
                 "drivers": {
@@ -103,7 +96,7 @@ def test_profile_loading_config_ok(apio_runner: ApioRunner):
         profile = Profile(
             sb.home_dir,
             sb.packages_dir,
-            get_remote_config_url(apio_ctx),
+            apio_ctx.profile.remote_config_url,
             5,  # TTL in days
             60,  # Remote config retry mins.
             RemoteConfigPolicy.CACHED_OK,
@@ -146,7 +139,7 @@ def test_profile_loading_config_stale_version(apio_runner: ApioRunner):
         profile = Profile(
             sb.home_dir,
             sb.packages_dir,
-            get_remote_config_url(apio_ctx),
+            apio_ctx.profile.remote_config_url,
             5,  # TTL in days
             60,  # Remote config retry mins.
             RemoteConfigPolicy.CACHED_OK,

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,9 @@`
`20`	`20`	`// The value of the remote config field here can be overridden for testing`
`21`	`21`	`// using the env var APIO_REMOTE_CONFIG_URL, including for reading from`
`22`	`22`	`// a local file using the "file://" protocol spec.`
	`23`	`+ //`
	`24`	`+ // For testing using the remote config at zapta:`
	`25`	`+ // export APIO_REMOTE_CONFIG_URL="https://github.com/zapta/apio/raw/develop/remote-config/apio-{V}.jsonc"`
`23`	`26`
`24`	`27`	`"remote-config-url": "https://github.com/fpgawars/apio/raw/develop/remote-config/apio-{V}.jsonc"`
`25`	`28`	`}`