ci: cache xcframework builds (#5449)

Author: armcknight

.github/workflows/assemble-xcframework-variant.yml

@@ -70,25 +70,48 @@ jobs:
           MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
           MATCH_USERNAME: ${{ secrets.MATCH_USERNAME }}
 
+      - name: Compute cache key
+        run: |
+          sdks_string=${{inputs.sdks}}
+          sdks_string_slugified=${sdks_string//,/_}
+          echo "SENTRY_XCFRAMEWORK_CACHE_KEY=${{runner.os}}-xcframework-${{inputs.variant-id}}-$sdks_string_slugified-${{inputs.signed}}-${{hashFiles('Sources/**')}}-${{hashFiles('Sentry.xcodeproj/**')}}" >> $GITHUB_ENV
+
+      - name: Restore XCFramework cache
+        id: cache-xcframework
+        uses: actions/cache@v4
+        with:
+          key: ${{env.SENTRY_XCFRAMEWORK_CACHE_KEY}}
+          path: ${{inputs.name}}${{inputs.suffix}}.xcframework.zip
+
       - name: Download ${{inputs.variant-id}} Slices
+        if: steps.cache-xcframework.outputs.cache-hit != 'true'
         uses: actions/download-artifact@v4
         with:
           pattern: xcframework-${{inputs.variant-id}}-slice-*
           path: xcframework-slices
 
       - name: Unzip slice artifact ZIP archives
+        if: steps.cache-xcframework.outputs.cache-hit != 'true'
         run: |
           find xcframework-slices -type f -print0 | xargs -t0I @ unzip @ -d xcframework-slices
         shell: bash
 
       - name: Assemble XCFramework
+        if: steps.cache-xcframework.outputs.cache-hit != 'true'
         run: ./scripts/assemble-xcframework.sh "${{inputs.name}}" "${{inputs.suffix}}" "${{inputs.configuration-suffix}}" "${{inputs.sdks}}" "/Users/runner/work/sentry-cocoa/sentry-cocoa/xcframework-slices/SDK_NAME.xcarchive"
         shell: bash
 
       - name: Zip XCFramework
+        if: steps.cache-xcframework.outputs.cache-hit != 'true'
         run: ./scripts/compress-xcframework.sh ${{inputs.signed && '--sign' || '--not-signed'}} ${{inputs.name}}${{inputs.suffix}}
         shell: bash
 
+      - name: Cache XCFramework
+        uses: actions/cache@v4
+        with:
+          key: ${{env.SENTRY_XCFRAMEWORK_CACHE_KEY}}
+          path: ${{inputs.name}}${{inputs.suffix}}.xcframework.zip
+
       - name: Upload XCFramework
         uses: actions/upload-artifact@v4
         with:

.github/workflows/build-xcframework-variant-slices.yml

@@ -85,29 +85,50 @@ jobs:
           fi
         shell: sh
 
+      - name: Compute cache key
+        run: |
+          echo "SENTRY_XCFRAMEWORK_CACHE_KEY=${{ runner.os }}-xcframework-${{inputs.variant-id}}-slice-${{matrix.sdk}}-${{ env.VERSION }}-${{hashFiles('Sources/**')}}-${{hashFiles('Sentry.xcodeproj/**')}}" >> $GITHUB_ENV
+
+      - name: Restore xcarchive cache
+        id: cache-xcarchive
+        uses: actions/cache@v4
+        with:
+          key: ${{env.SENTRY_XCFRAMEWORK_CACHE_KEY}}
+          path: ${{inputs.name}}${{inputs.suffix}}.xcarchive.zip
+
       - name: Bump version
+        if: steps.cache-xcarchive.outputs.cache-hit != 'true'
         run: |
           ./scripts/ci-select-xcode.sh 15.2
           make bump-version TO=${{ env.VERSION }}
 
       - name: Build ${{inputs.name}}${{inputs.suffix}} XCFramework slice for ${{matrix.sdk}}
+        if: steps.cache-xcarchive.outputs.cache-hit != 'true'
         run: ./scripts/build-xcframework-slice.sh ${{matrix.sdk}} ${{inputs.name}} "${{inputs.suffix}}" "${{inputs.macho-type}}" "${{inputs.configuration-suffix}}"
         shell: bash
 
       # The SentrySwiftUI archive build also builds Sentry.framework as a byproduct of the dependency. We need to remove that to avoid downstream assembly tasks from tripping on these extra files. In the future we could investigate using this byproduct instead of running a separate task for Sentry.framework, or use the one already built by that other task instead of rebuilding it here.
       - name: Remove Sentry.framework from SentrySwiftUI build
-        if: inputs.name == 'SentrySwiftUI'
+        if: steps.cache-xcarchive.outputs.cache-hit != 'true' && inputs.name == 'SentrySwiftUI'
         run: |
           find "${{github.workspace}}/Carthage/archive" -name "Sentry.framework" -print0 | xargs -t0 rm -rf
           find "${{github.workspace}}/Carthage/archive" -name "Sentry.framework.dSYM" -print0 | xargs -t0 rm -rf
         shell: bash
 
       # the upload action broke symlinks in the mac sdk slice's xcarchive
       - name: Zip xcarchive
+        if: steps.cache-xcarchive.outputs.cache-hit != 'true'
         run: |
           ditto -c -k -X --rsrc --keepParent ${{github.workspace}}/Carthage/archive/${{inputs.name}}${{inputs.suffix}}/${{matrix.sdk}}.xcarchive ${{inputs.name}}${{inputs.suffix}}.xcarchive.zip
         shell: bash
 
+      - name: Cache xcarchive
+        if: steps.cache-xcarchive.outputs.cache-hit != 'true'
+        uses: actions/cache@v4
+        with:
+          key: ${{env.SENTRY_XCFRAMEWORK_CACHE_KEY}}
+          path: ${{inputs.name}}${{inputs.suffix}}.xcarchive.zip
+
       - name: Upload xcarchive
         uses: actions/upload-artifact@v4
         with: