ci: define plugins.json

- add a script to parse `plugins.json`
- add workflows to to use and test the script

Signed-off-by: Yi Huang <[email protected]>

Author: 0yi0

.github/README.md

@@ -0,0 +1,39 @@
+# Misc Docs
+
+## Configuration Files
+
+### `plugins.json`
+
+```json
+{
+  "plugins": {
+    "<plugin-name>": {
+      "dir": "<path-to-plugin>",
+      "target": "<cmake-target-for-plugin>",
+      "test": "<cmake-target-for-test>",
+      "options": "<cmake-options>",
+      "platforms": [
+        {
+          "key": "<platform-key>"
+        },
+        {
+          "key": "<platform-key>",
+          "options": <extra-cmake-options>"
+        },
+        {
+          "key": "<platform-key>",
+          "options": <extra-cmake-options>",
+          "plugin_tag": "<extra-tag-for-plugin>"
+        }
+      }
+    }
+  },
+  "platforms": {
+    "<platform-key>": {
+      "runner": "<github-runner>",
+      "docker_tag": "<docker-tag>",
+      "asset_tag": "<asset-tag>"
+    }
+  }
+}
+```

.github/plugins.json

@@ -0,0 +1,55 @@
+{
+  "plugins": {
+    "wasi_crypto": {
+      "dir": "wasi_crypto",
+      "target": "wasmedgePluginWasiCrypto",
+      "test": "wasiCryptoTests",
+      "options": "-DWASMEDGE_PLUGIN_WASI_CRYPTO=ON",
+      "platforms": [
+        {"key":"manylinux_2_28_x86_64"},
+        {"key":"ubuntu2004_x86_64"}
+      ]
+    },
+    "wasi_nn-openvino": {
+      "dir": "wasi_nn",
+      "target": "wasmedgePluginWasiNN",
+      "test": "wasiNNTests",
+      "options": "-DWASMEDGE_PLUGIN_WASI_NN_BACKEND=OpenVINO",
+      "platforms": [
+        {"key":"ubuntu2004_x86_64"}
+      ]
+    },
+    "wasmedge_stablediffusion": {
+      "dir": "wasmedge_stablediffusion",
+      "target": "wasmedgePluginWasmEdgeStableDiffusion",
+      "test": "wasmedgeStableDiffusionTests",
+      "options": "-DWASMEDGE_PLUGIN_STABLEDIFFUSION=ON",
+      "platforms": [
+        {"key":"manylinux_2_28_x86_64"},
+        {"key":"ubuntu2004_x86_64"},
+        {
+          "key":"ubuntu2004_cuda11",
+          "options": "-DWASMEDGE_PLUGIN_STABLEDIFFUSION_CUDA=ON -DCMAKE_CUDA_ARCHITECTURES='60;61;70' -DCMAKE_CUDA_COMPILER=/usr/local/cuda/bin/nvcc",
+          "plugin_tag": "cuda-11"
+        }
+      ]
+    }
+  },
+  "platforms": {
+    "manylinux_2_28_x86_64": {
+      "runner": "ubuntu-latest",
+      "docker_tag": "manylinux_2_28_x86_64-plugins-deps",
+      "asset_tag": "manylinux_2_28_x86_64"
+    },
+    "ubuntu2004_x86_64": {
+      "runner": "ubuntu-latest",
+      "docker_tag": "ubuntu-20.04-plugin-deps",
+      "asset_tag": "ubuntu20.04_x86_64"
+    },
+    "ubuntu2004_cuda11": {
+      "runner": "ubuntu-latest",
+      "docker_tag": "ubuntu-20.04-cuda11",
+      "asset_tag": "ubuntu20.04_x86_64"
+    }
+  }
+}

.github/scripts/parse-plugins.js

@@ -0,0 +1,27 @@
+module.exports.parse = (config) => {
+  let map = new Map();
+  for (const platform_key of Object.keys(config.platforms)) {
+    map.set(platform_key, []);
+  }
+  for (const [plugin_key, plugin] of Object.entries(config.plugins)) {
+    for (const platform of plugin.platforms) {
+      if (!(platform.key in config.platforms))
+        continue;
+      let copy = { ...plugin, ...config.platforms[platform.key] };
+      delete copy.platforms;
+      copy.plugin = plugin_key;
+      copy.plugin_tag = platform.plugin_tag;
+      copy.options = [plugin.options, platform.options].join(" ");
+      map.get(platform.key).push(copy);
+    }
+  }
+  return Object.fromEntries(map);
+};
+
+if (require.main === module) {
+  const { parse } = module.exports;
+  const fs = require("fs");
+  const s = fs.readFileSync("plugins.json");
+  const o = JSON.parse(s);
+  console.log(JSON.stringify(parse(o)));
+}

.github/workflows/parse-plugins.yml

@@ -0,0 +1,52 @@
+---
+name: Parse
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - '.github/plugins.json'
+      - '.github/scripts/parse-plugins.js'
+      - '.github/workflows/parse-plugins.yml'
+
+  workflow_call:
+    inputs:
+      workflow_call: # workaround to distinguish ${{ github.event }}
+        type: boolean
+        default: true
+    outputs:
+      plugins:
+        value: ${{ jobs.parse.outputs.plugins }}
+
+jobs:
+  parse:
+    name: Parse configuration file
+    runs-on: ubuntu-latest
+    outputs:
+      plugins: ${{ steps.readfile.outputs.plugins }}
+    steps:
+      - uses: actions/checkout@v4
+      - id: readfile
+        uses: actions/github-script@v7
+        with:
+          result-encoding: string
+          script: |
+            const { parse } = require(".github/scripts/parse-plugins.js");
+            const fs = require("fs");
+            const s = fs.readFileSync(".github/plugins.json");
+            const config = parse(JSON.parse(s));
+            core.setOutput("plugins", config);
+
+  test:
+    if: ${{ !inputs.workflow_call }}
+    needs: parse
+    name: Self-testing
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get the first target from ubuntu2004_cuda11
+        run: |
+          echo "target=${{ fromJSON(needs.parse.outputs.plugins).ubuntu2004_cuda11[0].target }}" >> "${GITHUB_ENV}"
+      - name: Check target
+        run: |
+          echo "${target}"
+          test "${target}" = 'wasmedgePluginWasmEdgeStableDiffusion'