Improve runtime caching

Author: dorssel

.github/actions/calculate-cache-key/action.yml

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2024 Frans van Dorsselaer
+#
+# SPDX-License-Identifier: MIT
+
+---
+# yaml-language-server: $schema=https://json.schemastore.org/github-action.json
+
+name: 'Calculate cache key'
+
+description: 'Calculate the cache key for the given runtime'
+
+inputs:
+  runtime:
+    description: 'Runtime identifier'
+    required: true
+
+outputs:
+  key:
+    description: 'The key value for the runtime cache'
+    value: ${{ steps.calculate-cache-key.outputs.key }}
+
+runs:
+  using: composite
+
+  steps:
+    - name: Calculate cache key for ${{ inputs.runtime }}
+      id: calculate-cache-key
+      shell: bash
+      run: |
+        echo "key=runtime-${{ inputs.runtime }}-${{ hashFiles('.gitmodules', 'libc/libc.c', format('.github/workflows/runtime-{0}.yml', inputs.runtime)) }}" \
+          >> "$GITHUB_OUTPUT"

.github/actions/lookup-runtime-cache/action.yml

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: 2024 Frans van Dorsselaer
+#
+# SPDX-License-Identifier: MIT
+
+---
+# yaml-language-server: $schema=https://json.schemastore.org/github-action.json
+
+name: 'Lookup runtime cache'
+
+description: 'Checks if a cache exists for the given runtime'
+
+inputs:
+  runtime:
+    description: 'Runtime identifier'
+    required: true
+
+outputs:
+  cache-hit:
+    description: 'Indicates if the cache exists or not'
+    value: ${{ steps.cache-lookup.outputs.cache-hit }}
+
+runs:
+  using: composite
+
+  steps:
+    - name: Calculate cache key for ${{ inputs.runtime }}
+      id: calculate-cache-key
+      uses: ./.github/actions/calculate-cache-key
+      with:
+        runtime: ${{ inputs.runtime }}
+
+    - name: Lookup ${{ inputs.runtime }}
+      id: cache-lookup
+      uses: actions/cache/restore@v4
+      with:
+        key: ${{ steps.calculate-cache-key.outputs.key }}
+        path: |
+          Xmss/runtimes/**
+        enableCrossOsArchive: true
+        lookup-only: true

.github/actions/restore-runtime/action.yml

@@ -0,0 +1,34 @@
+# SPDX-FileCopyrightText: 2024 Frans van Dorsselaer
+#
+# SPDX-License-Identifier: MIT
+
+---
+# yaml-language-server: $schema=https://json.schemastore.org/github-action.json
+
+name: 'Restore runtime'
+
+description: 'Retrieve a previously cached runtime (which must exists)'
+
+inputs:
+  runtime:
+    description: 'Runtime identifier'
+    required: true
+
+runs:
+  using: composite
+
+  steps:
+    - name: Calculate cache key for ${{ inputs.runtime }}
+      id: calculate-cache-key
+      uses: ./.github/actions/calculate-cache-key
+      with:
+        runtime: ${{ inputs.runtime }}
+
+    - name: Restore runtime for ${{ inputs.runtime }}
+      id: restore
+      uses: actions/cache/restore@v4
+      with:
+        path: |
+          Xmss/runtimes/**
+        key: ${{ steps.calculate-cache-key.outputs.key }}
+        fail-on-cache-miss: true

.github/workflows/build.yml

@@ -35,9 +35,37 @@ jobs:
       contents: read
       actions: write
 
+  lookup-runtime-caches:
+    runs-on: ubuntu-latest
+
+    outputs:
+      osx-arm64: ${{ steps.lookup-osx-arm64.outputs.cache-hit }}
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v4
+
+      - name: Lookup osx-arm64
+        id: lookup-osx-arm64
+        uses: ./.github/actions/lookup-runtime-cache
+        with:
+          runtime: osx-arm64
+
+  runtime-osx-arm64:
+    needs: lookup-runtime-caches
+    if: ${{ !needs.lookup-runtime-caches.outputs.osx-arm64 }}
+    uses: ./.github/workflows/runtime-osx-arm64.yml
+    permissions:
+      contents: read
+      actions: write
+
   build-dotnet:
     needs:
       - cache-runtimes
+      - runtime-osx-arm64
+
+    if: always()
 
     runs-on: ubuntu-latest
 
@@ -63,6 +91,11 @@ jobs:
           key: runtime-win-x64-${{ hashFiles('.gitmodules', 'libc/libc.c', '.github/workflows/runtime-win-x64.yml') }}
           fail-on-cache-miss: true
 
+      - name: Restore osx-arm64 runtime
+        uses: ./.github/actions/restore-runtime
+        with:
+          runtime: osx-arm64
+
       - name: Restore browser-wasm artifact
         uses: actions/cache/restore@v4
         with:

.github/workflows/runtime-osx-arm64.yml

@@ -13,7 +13,19 @@ name: Runtime osx-arm64
 
 on:
   workflow_dispatch:
+    inputs:
+      ignore_cache:
+        description: 'Force building of the runtime, even if a cached result already exists.'
+        type: boolean
+        required: true
+        default: true
   workflow_call:
+    inputs:
+      ignore_cache:
+        description: 'Force building of the runtime, even if a cached result already exists.'
+        type: boolean
+        required: false
+        default: false
 
 env:
   RUNTIME: osx-arm64
@@ -38,7 +50,18 @@ jobs:
           echo "value=runtime-${{ env.RUNTIME }}-${{ hashFiles('.gitmodules', 'libc/libc.c', '.github/workflows/runtime-osx-arm64.yml') }}" \
             >> "$GITHUB_OUTPUT"
 
+      - name: Check existing cache
+        id: cache-check
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            Xmss/runtimes/**
+          key: ${{ steps.cache-key.outputs.value }}
+          enableCrossOsArchive: true
+          lookup-only: true
+
       - name: Configure
+        if: ${{ inputs.ignore_cache || !steps.cache-check.outputs.cache-hit }}
         run: >
           cmake
           -S xmss-library
@@ -49,36 +72,30 @@ jobs:
           -DCMAKE_C_FLAGS="-Wno-error=implicit-int-conversion"
 
       - name: Build
+        if: ${{ inputs.ignore_cache || !steps.cache-check.outputs.cache-hit }}
         run: cmake --build build
 
       - name: Test
+        if: ${{ inputs.ignore_cache || !steps.cache-check.outputs.cache-hit }}
         working-directory: build
         run: ctest
 
       - name: Copy artifact
+        if: ${{ inputs.ignore_cache || !steps.cache-check.outputs.cache-hit }}
         run: |
           mkdir -p "Xmss/runtimes/${{ env.RUNTIME }}/native"
           cp build/src/libxmss.dylib "Xmss/runtimes/${{ env.RUNTIME }}/native/xmss.dylib"
 
-      - name: Check existing cache
-        id: cache-check
-        uses: actions/cache/restore@v4
-        with:
-          path: |
-            Xmss/runtimes/**
-          key: ${{ steps.cache-key.outputs.value }}
-          enableCrossOsArchive: true
-          lookup-only: true
-
       - name: Delete existing cache
-        if: ${{ steps.cache-check.outputs.cache-hit }}
+        if: ${{ inputs.ignore_cache && steps.cache-check.outputs.cache-hit }}
         run: |
           gh extension install actions/gh-actions-cache
           gh actions-cache delete "${{ steps.cache-key.outputs.value }}" --confirm
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Save cache
+        if: ${{ inputs.ignore_cache || !steps.cache-check.outputs.cache-hit }}
         uses: actions/cache/save@v4
         with:
           path: |