feat: Add SentryDistribution

Author: noahsmartin

.github/actions/prepare-package.swift/action.yml

@@ -5,6 +5,12 @@ inputs:
     description: "Whether the build is a PR"
     required: true
     default: "false"
+  remove-duplicate:
+    description: "Whether to remove targets that produce duplicate files. These targets cause SPM validation errors."
+    default: "false"
+  change-path:
+    description: "Whether to change the path of the framework"
+    default: "true"
   package-file:
     description: "The package file to prepare"
     required: true
@@ -22,7 +28,17 @@ runs:
         sed -i '' '/Sentry-Dynamic-WithARM64e/d' $PACKAGE_FILE
         sed -i '' '/Sentry-WithoutUIKitOrAppKit-WithARM64e/d' $PACKAGE_FILE
         sed -i '' '/^[[:space:]]*\.binaryTarget($/{N;/\n[[:space:]]*),\{0,1\}$/d;}' $PACKAGE_FILE
+    - name: Remove duplicate target
+      if: ${{ inputs.remove-duplicate == 'true' }}
+      shell: bash
+      env:
+        PACKAGE_FILE: ${{ inputs.package-file }}
+      run: |
+        sed -i '' '/Sentry-Dynamic/d' $PACKAGE_FILE
+        sed -i '' '/Sentry-WithoutUIKitOrAppKit/d' $PACKAGE_FILE
+        sed -i '' '/^[[:space:]]*\.binaryTarget($/{N;/\n[[:space:]]*),\{0,1\}$/d;}' $PACKAGE_FILE
     - name: Change path of the framework
+      if: ${{ inputs.change-path == 'true' }}
       shell: bash
       env:
         PACKAGE_FILE: ${{ inputs.package-file }}

.github/workflows/build.yml

@@ -98,6 +98,8 @@ jobs:
             config: DebugV9
           - scheme: iOS-ObjectiveC
             config: DebugV9
+          - scheme: DistributionSample
+            config: Debug
 
     steps:
       - uses: actions/checkout@v5
@@ -129,6 +131,26 @@ jobs:
         if: ${{ failure() || cancelled() }}
         run: ./scripts/ci-diagnostics.sh
 
+  build-distribution:
+    name: Build the distribution framework
+    runs-on: macos-15
+    needs: files-changed
+    steps:
+      - uses: actions/checkout@v5
+
+      - run: ./scripts/ci-select-xcode.sh 16.4
+        shell: sh
+      - run: rm -r Sentry.xcodeproj && rm -r Sentry.xcworkspace
+      - run: set -o pipefail && NSUnbufferedIO=YES xcodebuild build -scheme SentryDistribution -sdk iphoneos -destination 'generic/platform=iphoneos' | tee raw-build-output-spm.log | xcbeautify
+        shell: sh
+      - name: Upload SPM Build Logs
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() || cancelled() }}
+        with:
+          name: raw-build-output-spm
+          path: |
+            raw-build-output-spm.log
+
   build-spm:
     name: Build with SPM
     runs-on: macos-15
@@ -340,6 +362,7 @@ jobs:
         files-changed,
         ios-swift-release,
         build-sample,
+        build-distribution,
         build-spm,
         build-v9,
         check-debug-without-UIKit,

.github/workflows/test.yml

@@ -92,6 +92,29 @@ jobs:
         if: failure()
         run: ./scripts/ci-diagnostics.sh
 
+  distribution-tests:
+    name: Distribution Tests
+    runs-on: macos-15
+    needs: files-changed
+    steps:
+      - uses: actions/checkout@v5
+      - name: Prepare Package.swift
+        uses: ./.github/actions/prepare-package.swift
+        with:
+          is-pr: ${{ github.event_name == 'pull_request' }}
+          change-path: false
+          remove-duplicate: true
+      - run: rm -r Sentry.xcodeproj && rm -r Sentry.xcworkspace
+      - run: set -o pipefail && NSUnbufferedIO=YES SKIP_BINARIES=1 xcodebuild test -scheme Sentry-Package -sdk iphonesimulator -destination 'platform=iOS Simulator,OS=18.4,name=iPhone 16 Pro' | tee raw-test-output-distribution.log | xcbeautify --preserve-unbeautified
+        shell: sh
+      - name: Upload Distribution Test Logs
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() || cancelled() }}
+        with:
+          name: raw-test-output-distribution
+          path: |
+            raw-test-output-distribution.log
+
   # This matrix runs only the unit tests requiring the test server.
   # We do this to speed up the other unit test jobs and to avoid running the
   # test server with potential side effects in GH actions for all unit tests.
@@ -453,6 +476,7 @@ jobs:
       [
         files-changed,
         build-test-server,
+        distribution-tests,
         unit-tests,
         unit-tests-with-test-server,
       ]

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add SentryDistribution as Swift Package Manager target (#6149)
+
 ## 8.56.2
 
 ### Fixes

Makefile

@@ -189,3 +189,4 @@ xcode-ci:
 	xcodegen --spec Samples/watchOS-Swift/watchOS-Swift.yml
 	xcodegen --spec TestSamples/SwiftUITestSample/SwiftUITestSample.yml
 	xcodegen --spec TestSamples/SwiftUICrashTest/SwiftUICrashTest.yml
+	xcodegen --spec Samples/DistributionSample/DistributionSample.yml

Package.swift

@@ -15,7 +15,8 @@ var products: [Product] = [
     .library(name: "Sentry-Dynamic-WithARM64e", targets: ["Sentry-Dynamic-WithARM64e"]),
     .library(name: "Sentry-WithoutUIKitOrAppKit", targets: ["Sentry-WithoutUIKitOrAppKit", "SentryCppHelper"]),
     .library(name: "Sentry-WithoutUIKitOrAppKit-WithARM64e", targets: ["Sentry-WithoutUIKitOrAppKit-WithARM64e", "SentryCppHelper"]),
-    .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI", "SentryCppHelper"])
+    .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI", "SentryCppHelper"]),
+    .library(name: "SentryDistribution", targets: ["SentryDistribution"])
 ]
 
 var targets: [Target] = [
@@ -66,7 +67,9 @@ var targets: [Target] = [
         linkerSettings: [
          .linkedLibrary("c++")
         ]
-    )
+    ),
+    .target(name: "SentryDistribution", path: "Sources/SentryDistribution"),
+    .testTarget(name: "SentryDistributionTests", dependencies: ["SentryDistribution"], path: "Sources/SentryDistributionTests")
 ]
 
 let env = getenv("EXPERIMENTAL_SPM_BUILDS")
@@ -101,7 +104,7 @@ if let env = env, String(cString: env, encoding: .utf8) == "1" {
             name: "SentryObjc",
             dependencies: ["SentrySwift"],
             path: "Sources",
-            exclude: ["Sentry/SentryDummyPublicEmptyClass.m", "Sentry/SentryDummyPrivateEmptyClass.m", "Swift", "SentrySwiftUI", "Resources", "Configuration", "SentryCppHelper"],
+            exclude: ["Sentry/SentryDummyPublicEmptyClass.m", "Sentry/SentryDummyPrivateEmptyClass.m", "Swift", "SentrySwiftUI", "Resources", "Configuration", "SentryCppHelper", "SentryDistribution", "SentryDistributionTests"],
             cSettings: [
                 .headerSearchPath("Sentry/include/HybridPublic"),
                 .headerSearchPath("Sentry"),

Samples/DistributionSample/DistributionSample.xcconfig

@@ -0,0 +1,4 @@
+PRODUCT_BUNDLE_IDENTIFIER = io.sentry.sample.DistributionSample
+INFOPLIST_FILE = DistributionSample/Info.plist
+SUPPORTED_PLATFORMS = iphoneos iphonesimulator
+IPHONEOS_DEPLOYMENT_TARGET = 15.0

Samples/DistributionSample/DistributionSample.yml

@@ -0,0 +1,31 @@
+name: DistributionSample
+createIntermediateGroups: true
+generateEmptyDirectories: true
+configs:
+  Debug: debug
+  Release: release
+options:
+  bundleIdPrefix: io.sentry.sample.
+packages:
+  Sentry:
+    path: ../../
+targets:
+  DistributionSample:
+    type: application
+    platform: auto
+    sources:
+      - DistributionSample
+    dependencies:
+      - package: Sentry
+        products:
+          - SentryDistribution
+    configFiles:
+      Debug: DistributionSample.xcconfig
+      Release: DistributionSample.xcconfig
+schemes:
+  DistributionSample:
+    templates:
+      - SampleAppScheme
+    build:
+      targets:
+        DistributionSample: all

Samples/DistributionSample/DistributionSample/App.swift

@@ -0,0 +1,10 @@
+import SwiftUI
+
+@main
+struct DemoAppApp: App {
+    var body: some Scene {
+        WindowGroup {
+            ContentView()
+        }
+    }
+}

Samples/DistributionSample/DistributionSample/Constants.swift

@@ -0,0 +1,7 @@
+import Foundation
+
+enum Constants {
+  static let accessToken = ""
+  static let organization = ""
+  static let project = ""
+}