#1: Allow for multiple names and results

Author: JacobDomagala

.github/workflows/test_action.yml

@@ -1,41 +1,12 @@
-name: Generate Badge
+name: Generate Badges
 
 on:
   pull_request:
 
 jobs:
   generate-badge:
     runs-on: ubuntu-latest
-    name: Generate Badge
-    strategy:
-      matrix:
-        image: ["vt-build-amd64-alpine-3-16-clang-cpp",
-                "vt-build-amd64-ubuntu-20-04-clang-10-cpp",
-                "vt-build-amd64-ubuntu-20-04-clang-9-cpp",
-                "vt-build-amd64-ubuntu-20-04-gcc-10-cpp",
-                "vt-build-amd64-ubuntu-20-04-gcc-10-openmpi-cpp",
-                "vt-build-amd64-ubuntu-20-04-gcc-9-cpp",
-                "vt-build-amd64-ubuntu-20-04-gcc-9-cuda-11-4-3-cpp",
-                "vt-build-amd64-ubuntu-20-04-gcc-9-cuda-12-2-0-cpp",
-                "vt-build-amd64-ubuntu-20-04-icpx-cpp",
-                "vt-build-amd64-ubuntu-22-04-clang-11-cpp",
-                "vt-build-amd64-ubuntu-22-04-clang-12-cpp",
-                "vt-build-amd64-ubuntu-22-04-clang-13-cpp",
-                "vt-build-amd64-ubuntu-22-04-clang-14-cpp",
-                "vt-build-amd64-ubuntu-22-04-clang-15-cpp",
-                "vt-build-amd64-ubuntu-22-04-gcc-11-cpp",
-                "vt-build-amd64-ubuntu-22-04-gcc-12-cpp",
-                "vt-build-amd64-ubuntu-22-04-gcc-12-vtk-cpp",
-                "vt-build-amd64-ubuntu-22-04-gcc-12-zoltan-cpp",
-                "vt-build-amd64-ubuntu-24-04-clang-16-cpp",
-                "vt-build-amd64-ubuntu-24-04-clang-16-vtk-cpp",
-                "vt-build-amd64-ubuntu-24-04-clang-16-zoltan-cpp",
-                "vt-build-amd64-ubuntu-24-04-clang-17-cpp",
-                "vt-build-amd64-ubuntu-24-04-clang-18-cpp",
-                "vt-build-amd64-ubuntu-24-04-gcc-13-cpp",
-                "vt-build-amd64-ubuntu-24-04-gcc-14-cpp",
-                "vt-build-amd64-ubuntu-20-04-gcc-10-openmpi-cpp-spack"]
-        result: ["success", "failure"]
+    name: Generate Badges
 
     steps:
       - uses: actions/checkout@v4
@@ -44,8 +15,16 @@ jobs:
         if: always()
         uses: DARMA-tasking/badge-generator@1-initial-version
         with:
-          name: ${{ matrix.image }}-${{ matrix.result }}
-          result: ${{ matrix.result }}
+          names: |
+            vt-build-amd64-alpine-3-16-clang-cpp
+            vt-build-amd64-ubuntu-20-04-gcc-9-cuda-12-2-0-cpp
+            vt-build-amd64-ubuntu-20-04-gcc-10-openmpi-cpp-spack
+            vt-build-amd64-ubuntu-22-04-gcc-12-cpp
+          results: |
+            success
+            cancelled
+            failure
+            failure
           github_token: ${{ secrets.GITHUB_TOKEN }}
 
   comment-on-pr:

action.yml

@@ -13,24 +13,14 @@ inputs:
   github_token:
     description: 'GitHub token with permissions to write to the wiki.'
     required: true
+  push:
+    description: 'Whether to push to wiki repository or not'
+    default: false
 
 # Define the execution logic for the action
 runs:
   using: 'composite'
   steps:
-    - name: Determine Badge Color
-      id: set_color
-      shell: bash
-      run: |
-        case "${{ inputs.result }}" in
-          success)
-            echo "COLOR=green" >> $GITHUB_ENV
-            ;;
-          failure)
-            echo "COLOR=red" >> $GITHUB_ENV
-            ;;
-        esac
-
     - name: Clone Wiki Repository
       shell: bash
       run: |
@@ -39,22 +29,33 @@ runs:
     - name: Generate and Save Badge
       shell: bash
       run: |
-        set -x
+        set -euo pipefail
+        readarray -t NAMES   <<< "${{ inputs.names }}"
+        readarray -t RESULTS <<< "${{ inputs.results }}"
+
+        [ "${#NAMES[@]}" -eq "${#RESULTS[@]}" ] || { echo "names and results lengths differ" >&2; exit 1; }
+
+        mkdir -p "wiki/${GITHUB_REPOSITORY}"
+
+        for i in "${!NAMES[@]}"; do
+          NAME=${NAMES[$i]}
+          RESULT=${RESULTS[$i]}
 
-        # Make sure we encode spaces and dashes
-        # Shields.io URL format: https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>
-        # Any - in <MESSAGE> or <LABEL> must be escaped to %2D (URL encoding), otherwise Shields.io treats it as a delimiter.
-        ENCODED_NAME=$(echo "${{ inputs.name }}" | sed -e 's/-/--/g')
-        echo "ENCODED_NAME: $ENCODED_NAME"
+          case "$RESULT" in
+            success)   COLOR=green ;;
+            failure)   COLOR=red   ;;
+            cancelled) COLOR=gray  ;;
+            *)         COLOR=gray  ;;
+          esac
 
-        BADGE_URL="https://img.shields.io/badge/${ENCODED_NAME}-${{ inputs.result }}-${{ env.COLOR }}.svg"
-        echo "BADGE_URL: $BADGE_URL"
+          ENCODED_NAME=$(echo "$NAME" | sed 's/-/--/g')
+          BADGE_URL="https://img.shields.io/badge/${ENCODED_NAME}-${RESULT}-${COLOR}.svg"
 
-        # Download the badge using curl
-        mkdir -p wiki/${GITHUB_REPOSITORY}
-        curl -s -o "wiki/${GITHUB_REPOSITORY}/${{ inputs.name }}-badge.svg" "${BADGE_URL}"
+          curl -s -o "wiki/${GITHUB_REPOSITORY}/${NAME}-badge.svg" "$BADGE_URL"
+        done
 
     - name: Commit and Push to Wiki
+      if: ${{ inputs.push }}
       shell: bash
       run: |
         cd wiki