ci: parallelize xcframework slice builds

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

@@ -0,0 +1,49 @@
+name: "Assemble Sentry Cocoa XCFramework variant"
+
+on:
+  workflow_call:
+    inputs:
+      name:
+        description: |-
+          The Sentry project target to build an XCFramework slice for.
+          Possible values: Sentry, SentrySwiftUI.
+        required: true
+        type: string
+
+      suffix:
+        description: |-
+          The suffix to add to the build product name.
+          E.g. "-Dynamic" or "-WithoutUIKitOrAppKit".
+        required: false
+        type: string
+
+      variant-id:
+        description: |-
+          The ID of the variant to build an XCFramework slice for. Used to collect appropriate slices for final deliverable assembly.
+        required: true
+        type: string
+
+jobs:
+  assemble-xcframework-variant:
+    name: Assemble ${{inputs.name}}${{inputs.suffix}} XCFramework Variant
+
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download ${{inputs.variant-id}} Slices
+        uses: actions/download-artifact@v4
+        with:
+          pattern: xcframework-${{inputs.variant-id}}-slice-*
+          path: xcframework-slices
+
+      - name: Assemble XCFramework
+        run: ./scripts/assemble-xcframework.sh "${{github.workspace}}/xcframework-slices" "${{inputs.name}}${{inputs.suffix}}"
+        shell: bash
+
+      - name: Archive XCFramework
+        uses: actions/upload-artifact@v4
+        with:
+          name: xcframework-${{github.sha}}-${{inputs.variant-id}}
+          if-no-files-found: error
+          path: ${{inputs.name}}${{inputs.suffix}}.xcframework.zip

.github/workflows/benchmarking.yml

@@ -15,11 +15,14 @@ on:
       - ".sauce/benchmarking-config.yml"
       - "fastlane/**"
       - "scripts/ci-select-xcode.sh"
-      - "scripts/build-xcframework.sh"
       - "Samples/iOS-Swift/iOS-Swift.yml"
       - "Samples/iOS-Swift/iOS-Swift.xcconfig"
       - "Samples/iOS-Swift/iOS-SwiftClilp.xcconfig"
       - "Samples/iOS-Swift/iOS-Benchmarking.xcconfig"
+      - "scripts/build-xcframework-slice.sh"
+      - "scripts/assemble-xcframework.sh"
+      - ".github/workflows/build-xcframework-variant-slices.yml"
+      - ".github/workflows/assemble-xcframework-variant.yml"
 
 # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
 concurrency:
@@ -169,9 +172,27 @@ jobs:
             --tags benchmark \
             --verbose
 
+  build-xcframework-variant-slices:
+    uses: ./.github/workflows/build-xcframework-variant-slices.yml
+    with:
+      name: Sentry
+      suffix: "-Dynamic"
+      variant-id: sentry-dynamic
+      sdk-list: '["iphoneos", "iphonesimulator"]'
+      include-maccatalyst: "false"
+
+  assemble-xcframework-variant:
+    needs: build-xcframework-variant-slices
+    uses: ./.github/workflows/assemble-xcframework-variant.yml
+    with:
+      name: Sentry
+      suffix: "-Dynamic"
+      variant-id: sentry-dynamic
+
   app-metrics:
     name: Collect app metrics
     runs-on: macos-15
+    needs: assemble-xcframework-variant
     steps:
       - name: Git checkout
         uses: actions/checkout@v4
@@ -195,17 +216,11 @@ jobs:
           MATCH_GIT_PRIVATE_KEY: ${{ secrets.MATCH_GIT_PRIVATE_KEY }}
           MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
           MATCH_USERNAME: ${{ secrets.MATCH_USERNAME }}
-      - name: Build Framework
-        run: ./scripts/build-xcframework.sh iOSOnly
-
-      - name: Archive build log if failed
-        uses: actions/upload-artifact@v4
-        if: ${{ failure() || cancelled() }}
+      - uses: actions/download-artifact@v4
         with:
-          name: raw-build-output-build-xcframework
-          path: |
-            build-xcframework.log
-
+          pattern: xcframework-${{github.sha}}-sentry-dynamic
+          path: Carthage/
+      - run: find Carthage -name "Sentry-Dynamic.xcframework.zip" -print0 | xargs -t0I @ unzip @ -d Carthage
       - name: Build test app with sentry
         run: bundle exec fastlane build_perf_test_app_sentry
         env:

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

@@ -0,0 +1,105 @@
+name: "Build Sentry Cocoa XCFramework variant slices"
+
+on:
+  workflow_call:
+    inputs:
+      sdk-list:
+        description: |-
+          The list of Apple platform SDKs for which to build slices and assemble into an XCFramework. This must be a JSON array of strings, itself in a string since GitHub Actions doesn't support arrays as inputs.
+          Possible values: iphoneos, iphonesimulator, macosx, appletvos, appletvsimulator, watchos, watchsimulator, xros, xrsimulator.
+        required: false
+        default: '["iphoneos", "iphonesimulator", "macosx", "appletvos", "appletvsimulator", "watchos", "watchsimulator", "xros", "xrsimulator"]'
+        type: string
+
+      name:
+        description: |-
+          The Sentry project target to build an XCFramework slice for.
+          Possible values: Sentry, SentrySwiftUI.
+        required: true
+        type: string
+
+      suffix:
+        description: |-
+          The suffix to add to the build product name.
+          E.g. "-Dynamic" or "-WithoutUIKitOrAppKit".
+        required: false
+        type: string
+
+      macho-type:
+        description: |-
+          The Mach-O type of the build product.
+          Possible values: mh_dylib, staticlib.
+        required: false
+        type: string
+        default: "mh_dylib"
+
+      configuration-suffix:
+        description: |-
+          The suffix to add to the build product name to build an alternate configuration of the target.
+          E.g. "WithoutUIKit".
+        required: false
+        type: string
+
+      variant-id:
+        description: |-
+          The ID of the variant to build an XCFramework slice for. Used to collect appropriate slices for final deliverable assembly.
+        required: true
+        type: string
+
+      include-maccatalyst:
+        description: |-
+          Directs whether or not to build a Mac Catalyst compatible slice.
+        required: false
+        type: string
+        default: "false"
+
+jobs:
+  build-xcframework-variant-slices:
+    name: Build ${{inputs.name}}${{inputs.suffix}} XCFramework Variant Slice for ${{matrix.sdk}}
+
+    # We must compile this on an arm64 runner, cause it's required for visionOS. macos-14 uses arm64.
+    # To see the available runners see https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories.
+    runs-on: macos-14
+
+    strategy:
+      matrix:
+        sdk: ${{ fromJson(inputs.sdk-list) }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # We have to compile on Xcode 15.2 because compiling on Xcode 15.4 fails with
+      # Data+SentryTracing.swift:21:62: error: 'ReadingOptions' aliases 'Foundation.ReadingOptions'
+      # and cannot be used here because C++ types from imported module 'Foundation' do not support
+      # library evolution; this is an error in the Swift 6 language mode
+      # We also can't use Xcode 16.x because validating the XCFramework then fails with Xcode 15.x.
+      - run: ./scripts/ci-select-xcode.sh 15.2
+        shell: bash
+
+      - name: Build ${{inputs.name}}${{inputs.suffix}} XCFramework slice for ${{matrix.sdk}}
+        if: startsWith(github.ref, 'refs/heads/release/') == false
+        run: ./scripts/build-xcframework-slice.sh ${{matrix.sdk}} ${{inputs.name}} "${{inputs.suffix}}" ${{inputs.macho-type}} ${{inputs.include-maccatalyst}} ${{inputs.configuration-suffix}}
+        shell: bash
+
+      - name: Remove Sentry.framework from SentrySwiftUI build
+        if: 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
+
+      - name: Archiving xcarchive
+        uses: actions/upload-artifact@v4
+        with:
+          name: xcframework-${{inputs.variant-id}}-slice-${{matrix.sdk}}
+          if-no-files-found: error
+          path: |
+            ${{github.workspace}}/Carthage/archive/${{inputs.name}}${{inputs.suffix}}/${{matrix.sdk}}.xcarchive
+
+      - name: Archive build log if failed
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() || cancelled() }}
+        with:
+          name: raw-build-output-build-xcframework-${{inputs.variant-id}}-${{matrix.sdk}}
+          path: |
+            *.log

.github/workflows/build-xcframework.yml

@@ -0,0 +1,156 @@
+name: "Build Sentry XCFramework"
+on:
+  push:
+    branches:
+      - main
+      - release/**
+
+  pull_request:
+    paths:
+      - "Sources/**"
+      - ".github/workflows/build-xcframework.yml"
+      - "scripts/ci-select-xcode.sh"
+      - Sentry.xcworkspace/**
+      - Sentry.xcodeproj/**
+      - "Package.swift"
+      - "scripts/build-xcframework-slice.sh"
+      - "scripts/assemble-xcframework.sh"
+      - ".github/workflows/build-xcframework-variant-slices.yml"
+      - ".github/workflows/assemble-xcframework-variant.yml"
+      - Samples/macOS-SPM-CommandLine/**
+      - Samples/SPM-Dynamic/**
+
+# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build-xcframework-variant-slices:
+    uses: ./.github/workflows/build-xcframework-variant-slices.yml
+    with:
+      name: ${{matrix.variant.name}}
+      suffix: ${{matrix.variant.suffix}}
+      macho-type: ${{matrix.variant.macho-type}}
+      configuration-suffix: ${{matrix.variant.configuration-suffix}}
+      variant-id: ${{matrix.variant.id}}
+      include-maccatalyst: ${{matrix.include-maccatalyst}}
+    strategy:
+      matrix:
+        variant:
+          - name: Sentry
+            suffix: "-Dynamic"
+            id: sentry-dynamic
+            include-maccatalyst: "true"
+          - name: Sentry
+            macho-type: staticlib
+            id: sentry-static
+          - name: SentrySwiftUI
+            id: sentryswiftui
+          - name: Sentry
+            suffix: "-WithoutUIKitOrAppKit"
+            macho-type: mh_dylib
+            configuration-suffix: WithoutUIKit
+            id: sentry-withoutuikit-dynamic
+
+  assemble-xcframework-variant:
+    needs: build-xcframework-variant-slices
+    uses: ./.github/workflows/assemble-xcframework-variant.yml
+    with:
+      name: ${{matrix.variant.name}}
+      suffix: ${{matrix.variant.suffix}}
+      variant-id: ${{matrix.variant.id}}
+    strategy:
+      matrix:
+        variant:
+          - name: Sentry
+            suffix: "-Dynamic"
+            id: sentry-dynamic
+          - name: Sentry
+            id: sentry-static
+          - name: SentrySwiftUI
+            id: sentryswiftui
+          - name: Sentry
+            suffix: "-WithoutUIKitOrAppKit"
+            id: sentry-withoutuikit-dynamic
+
+  validate-xcframework:
+    name: Validate XCFramework
+    runs-on: macos-13
+    needs: assemble-xcframework-variant
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: xcframework-${{github.sha}}-sentry-static
+          path: Carthage/
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: xcframework-${{github.sha}}-sentryswiftui
+          path: Carthage/
+      - run: find Carthage -name "*.zip" -print0 | xargs -t0I @ mv @ Carthage
+      - run: ./scripts/ci-select-xcode.sh 15.2
+      - run: make build-xcframework-sample
+        shell: sh
+
+  # Use github.event.pull_request.head.sha instead of github.sha when available as
+  # the github.sha is be the pre merge commit id for PRs.
+  # See https://github.community/t/github-sha-isnt-the-value-expected/17903/17906.
+  validate-spm:
+    name: Validate Swift Package Manager
+    runs-on: macos-13
+    needs: assemble-xcframework-variant
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: xcframework-${{github.sha}}-*
+          merge-multiple: true
+      - name: Change path of the framework
+        run: |
+          sed -i '' 's/url.*//g' Package.swift
+          sed -i '' 's/checksum: ".*" \/\/Sentry-Static/path: "Sentry.xcframework.zip"/g' Package.swift
+          sed -i '' 's/checksum: ".*" \/\/Sentry-Dynamic/path: "Sentry-Dynamic.xcframework.zip"/g' Package.swift
+        shell: bash
+      - run: swift build
+        working-directory: Samples/macOS-SPM-CommandLine
+        shell: sh
+
+  validate-spm-dynamic:
+    name: Validate Swift Package Manager Dynamic
+    runs-on: macos-13
+    needs: assemble-xcframework-variant
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: xcframework-${{github.sha}}-*
+          merge-multiple: true
+      - name: Change path of the framework
+        run: |
+          sed -i '' 's/url.*//g' Package.swift
+          sed -i '' 's/checksum: ".*" \/\/Sentry-Static/path: "Sentry.xcframework.zip"/g' Package.swift
+          sed -i '' 's/checksum: ".*" \/\/Sentry-Dynamic/path: "Sentry-Dynamic.xcframework.zip"/g' Package.swift
+        shell: bash
+      - run: swift build
+        working-directory: Samples/SPM-Dynamic
+        shell: sh
+
+  swift-build:
+    name: Build with Swift
+    runs-on: macos-13
+    needs: assemble-xcframework-variant
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: xcframework-${{github.sha}}-*
+          merge-multiple: true
+      - name: Change path of the framework
+        run: |
+          sed -i '' 's/url.*//g' Package.swift
+          sed -i '' 's/checksum: ".*" \/\/Sentry-Static/path: "Sentry.xcframework.zip"/g' Package.swift
+          sed -i '' 's/checksum: ".*" \/\/Sentry-Dynamic/path: "Sentry-Dynamic.xcframework.zip"/g' Package.swift
+        shell: bash
+      - run: swift build
+        shell: sh