chore: Download the Cocoa SDK instead of building it (#681)

* Rework CI to download cocoa instead of building

* Fix paths

* Remove cocoa submodule

* Fix paths

* Fix file name

* Update deps workflow

* Rename job

* Update changelog

* Update scripts

* Merge ios and mac dependencies loading into  a single script

* Fix dir path

* Fix path again

* Fix missing dir check

* Update CHANGELOG.md

Author: tustanivsky

.github/workflows/ci.yml

@@ -4,39 +4,39 @@ on: push
 
 jobs:
   android-sdk:
-    uses: ./.github/workflows/sdk.yml
+    uses: ./.github/workflows/sdk-build.yml
     with:
       target: Android
       runsOn: ubuntu-latest
 
   ios-sdk:
-    uses: ./.github/workflows/sdk.yml
+    uses: ./.github/workflows/sdk-download.yml
     with:
       target: IOS
-      runsOn: macos-13
+      runsOn: ubuntu-latest
 
   macos-sdk:
-    uses: ./.github/workflows/sdk.yml
+    uses: ./.github/workflows/sdk-download.yml
     with:
       target: Mac
-      runsOn: macos-13
+      runsOn: ubuntu-latest
 
   linux-sdk:
-    uses: ./.github/workflows/sdk.yml
+    uses: ./.github/workflows/sdk-build.yml
     with:
       target: Linux
       # Build for an older GLIBC so that it can run with the old GLIBC included in EpicGames' Unreal docker images.
       # See discussion in https://github.com/getsentry/sentry-unreal/pull/173
       runsOn: ubuntu-20.04
 
   windows-crashpad-sdk:
-    uses: ./.github/workflows/sdk.yml
+    uses: ./.github/workflows/sdk-build.yml
     with:
       target: Win64-Crashpad
       runsOn: windows-2019
 
   windows-breakpad-sdk:
-    uses: ./.github/workflows/sdk.yml
+    uses: ./.github/workflows/sdk-build.yml
     with:
       target: Win64-Breakpad
       runsOn: windows-2019

.github/workflows/sdk.yml renamed to .github/workflows/sdk-build.yml

@@ -23,8 +23,6 @@ jobs:
         run: |
           if [[ "${{ inputs.target }}" == "Android" ]]; then
             submodule="modules/sentry-java"
-          elif [[ "${{ inputs.target }}" == "IOS" || "${{ inputs.target }}" == "Mac" ]]; then
-            submodule="modules/sentry-cocoa"
           else
             submodule="modules/sentry-native"
           fi

.github/workflows/sdk-download.yml

@@ -0,0 +1,48 @@
+on:
+  workflow_call:
+    inputs:
+      runsOn:
+        required: true
+        type: string
+      target:
+        required: true
+        type: string
+
+jobs:
+  download:
+    runs-on: ${{ inputs.runsOn }}
+    timeout-minutes: 30
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Select properties file
+        id: env
+        run: |
+          if [[ "${{ inputs.target }}" == "IOS" || "${{ inputs.target }}" == "Mac" ]]; then
+            echo "cacheLocation=modules/sentry-cocoa" >> $GITHUB_OUTPUT
+            echo "propertiesFile=modules/sentry-cocoa.properties"  >> $GITHUB_OUTPUT
+            echo "downloadScript=scripts/download-cocoa.sh" >> $GITHUB_OUTPUT
+          fi
+          echo "path=plugin-dev/Source/ThirdParty/${{ inputs.target }}" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        id: cache
+        with:
+          path: |
+            ${{ steps.env.outputs.path }}
+          key: sdk=${{ inputs.target }}-${{ hashFiles(steps.env.outputs.propertiesFile, 'scripts/download-*.sh', '.github/workflows/sdk-download.yml') }}
+
+      - name: Download
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          mkdir -p '${{ steps.env.outputs.path }}'
+          ${{ steps.env.outputs.downloadScript }} '${{ steps.env.outputs.cacheLocation }}' '${{ steps.env.outputs.path }}'
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ inputs.target }}-sdk
+          path: ${{ steps.env.outputs.path }}
+          retention-days: ${{ github.ref_name == 'main' && 14 || 1 }}

.github/workflows/update-dependencies.yml

@@ -29,8 +29,8 @@ jobs:
   cocoa:
     uses: getsentry/github-workflows/.github/workflows/updater.yml@v2
     with:
-      path: modules/sentry-cocoa
-      name: Cocoa SDK (iOS)
+      path: modules/sentry-cocoa.properties
+      name: Cocoa SDK (iOS and Mac)
     secrets:
       api-token: ${{ secrets.CI_DEPLOY_KEY }}
 

.gitmodules

@@ -4,6 +4,3 @@ url = https://github.com/getsentry/sentry-java.git
 [submodule "modules/sentry-native"]
 path = modules/sentry-native
 url = https://github.com/getsentry/sentry-native.git
-[submodule "modules/sentry-cocoa"]
-path = modules/sentry-cocoa
-url = https://github.com/getsentry/sentry-cocoa

CHANGELOG.md

@@ -12,24 +12,15 @@
 - Bump CLI from v2.37.0 to v2.38.2 ([#663](https://github.com/getsentry/sentry-unreal/pull/663), [#670](https://github.com/getsentry/sentry-unreal/pull/670), [#677](https://github.com/getsentry/sentry-unreal/pull/677))
   - [changelog](https://github.com/getsentry/sentry-cli/blob/master/CHANGELOG.md#2382)
   - [diff](https://github.com/getsentry/sentry-cli/compare/2.37.0...2.38.2)
-- Bump Java SDK (Android) from v7.15.0 to v7.16.0 ([#665](https://github.com/getsentry/sentry-unreal/pull/665))
-  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#7160)
-  - [diff](https://github.com/getsentry/sentry-java/compare/7.15.0...7.16.0)
+- Bump Java SDK (Android) from v7.15.0 to v7.17.0 ([#665](https://github.com/getsentry/sentry-unreal/pull/665), [#682](https://github.com/getsentry/sentry-unreal/pull/682))
+  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#7170)
+  - [diff](https://github.com/getsentry/sentry-java/compare/7.15.0...7.17.0)
 - Bump Native SDK from v0.7.6 to v0.7.12 ([#667](https://github.com/getsentry/sentry-unreal/pull/667), [#678](https://github.com/getsentry/sentry-unreal/pull/678))
   - [changelog](https://github.com/getsentry/sentry-native/blob/master/CHANGELOG.md#0712)
   - [diff](https://github.com/getsentry/sentry-native/compare/0.7.6...0.7.12)
-- Bump Cocoa SDK (iOS) from v8.38.0 to v8.39.0 ([#668](https://github.com/getsentry/sentry-unreal/pull/668))
-  - [changelog](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8390)
-  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.38.0...8.39.0)
-- Bump Cocoa SDK (iOS) from v8.40.0-5-gf31a3eff to v8.40.0 ([#679](https://github.com/getsentry/sentry-unreal/pull/679))
-  - [changelog](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8400)
-  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.40.0-5-gf31a3eff...8.40.0)
-- Bump Cocoa SDK (iOS) from v8.40.0 to v8.40.1 ([#680](https://github.com/getsentry/sentry-unreal/pull/680))
+- Bump Cocoa SDK (iOS) from v8.38.0 to v8.40.1 ([#668](https://github.com/getsentry/sentry-unreal/pull/668), [#679](https://github.com/getsentry/sentry-unreal/pull/679), [#680](https://github.com/getsentry/sentry-unreal/pull/680))
   - [changelog](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8401)
-  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.40.0...8.40.1)
-- Bump Java SDK (Android) from v7.16.0 to v7.17.0 ([#682](https://github.com/getsentry/sentry-unreal/pull/682))
-  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#7170)
-  - [diff](https://github.com/getsentry/sentry-java/compare/7.16.0...7.17.0)
+  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.38.0...8.40.1)
 
 ## 0.20.1
 

modules/sentry-cocoa.properties

@@ -0,0 +1,2 @@
+version=8.40.1
+repo=https://github.com/getsentry/sentry-cocoa

scripts/build-ios.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+set -euo pipefail
+
+function getProperty {
+    cat "$(dirname $0)/../modules/sentry-cocoa.properties" | grep $1 | cut -d'=' -f2 | tr -d '"'
+}
+
+export sentryCocoaCache=$1
+export sentryArtifactsDestination=$2
+
+if ! [ -d "$sentryCocoaCache" ]; then
+    mkdir $sentryCocoaCache
+fi
+
+cocoaRepo=$(getProperty 'repo')
+cocoaVersion=$(getProperty 'version')
+
+cocoaFrameworkUrl="${cocoaRepo}/releases/download/${cocoaVersion}/Sentry-Dynamic.xcframework.zip"
+
+curl -L "${cocoaFrameworkUrl}" -o "${sentryCocoaCache}/Sentry-Dynamic.xcframework.zip"
+
+unzip -o "${sentryCocoaCache}/Sentry-Dynamic.xcframework.zip" -d "${sentryCocoaCache}/"
+
+# Prepare iOS artifacts
+
+if ! [ -d "$(dirname $sentryArtifactsDestination)/IOS" ]; then
+    mkdir "$(dirname $sentryArtifactsDestination)/IOS"
+else
+    rm -rf "$(dirname $sentryArtifactsDestination)/IOS/"*
+fi
+
+cp -R "${sentryCocoaCache}/Sentry-Dynamic.xcframework/ios-arm64_arm64e/Sentry.framework" "$(dirname $sentryArtifactsDestination)/IOS/Sentry.framework"
+
+mkdir "Sentry.embeddedframework"
+
+cp -R "$(dirname $sentryArtifactsDestination)/IOS/Sentry.framework" "Sentry.embeddedframework"
+zip -r "Sentry.embeddedframework.zip" "Sentry.embeddedframework"
+cp -R "Sentry.embeddedframework.zip" "$(dirname $sentryArtifactsDestination)/IOS/Sentry.embeddedframework.zip"
+
+rm -rf "Sentry.embeddedframework"
+rm "Sentry.embeddedframework.zip"
+
+# Prepare Mac artifacts
+
+if ! [ -d "$(dirname $sentryArtifactsDestination)/Mac" ]; then
+    mkdir "$(dirname $sentryArtifactsDestination)/Mac"
+else
+    rm -rf "$(dirname $sentryArtifactsDestination)/Mac/"*
+fi
+
+mkdir "$(dirname $sentryArtifactsDestination)/Mac/bin"
+mkdir "$(dirname $sentryArtifactsDestination)/Mac/include"
+
+cp "${sentryCocoaCache}/Sentry-Dynamic.xcframework/macos-arm64_arm64e_x86_64/Sentry.framework/Sentry" "$(dirname $sentryArtifactsDestination)/Mac/bin/sentry.dylib"
+
+cp -rL "${sentryCocoaCache}/Sentry-Dynamic.xcframework/macos-arm64_arm64e_x86_64/Sentry.framework/Headers" "$(dirname $sentryArtifactsDestination)/Mac/include/Sentry"
+cp -rL "${sentryCocoaCache}/Sentry-Dynamic.xcframework/macos-arm64_arm64e_x86_64/Sentry.framework/PrivateHeaders/." "$(dirname $sentryArtifactsDestination)/Mac/include/Sentry"