chore: Add dedicated CI workflow for 3rd-party integrations (#6945)

itaybre · denrase · web-flow · commit c9976e203630 · 2026-02-12T20:48:54.000-03:00
* Add `SenrtySwiftLog` integration

* Add default `swift package init` .gitignore

* chore: Add test workflow for swift log

* Add macOS version

* Remove file-filter

* Update integration's package to use local path

* Add ci job to run test

* Add files-changed gate

* Fix example commands

* Add SPM test to required checks

* update folder structure

* update name

* Update `sentry-xcodebuild.sh` to be compatible with SPM packages

* Add `--update-path-to-sentry-cocoa` to prepare-package.sh

* Improve script

* Reuse existing `unit-test-common.yml`

* Fix path

* Update GitHub Actions workflow to use 'runs-on' for macOS version

* Remove unnecesary files

* Add missing parameters

* Update GitHub Actions workflow to correct script path for package preparation

* Add debugging steps to unit-test-common.yml for improved visibility during testing

* Update paths

* Update path

* Update path in prepare-package.sh for Sentry Cocoa package reference

* Add support for testing SPM packages in CI workflows

* Add comment

* delete old/unused fils from previous merge

* Changed the working directory for SwiftLog integration to SentrySwiftLog in CI workflows.

Removed the option to update the path to sentry-cocoa from the prepare-package.sh script and use `swift package edit` directly.

* - Introduced a new workflow for testing 3rd-party integrations, consolidating tests for SentrySwiftLog, SentrySwiftyBeaver, SentryCocoaLumberjack, and SentryPulse.

- Updated file filters to trigger tests based on changes in the 3rd-party integrations directory

- Removed outdated unit test jobs from the main test workflow to streamline CI processes.

* Updated the variable name from `path_to_scripts_folder` to `scripts_directory` in both the 3rd-party integrations and unit test workflows for consistency and clarity. Adjusted script execution commands to utilize the new variable name.

* Update actions/checkout version in 3rd-party integrations workflow to improve consistency across jobs.

* Add tests for SentrySwiftyBeaver, SentryCocoaLumberjack, and SentryPulse in the 3rd-party integrations workflow with scheme/xcode

* Rename and update the Xcode integration test job to `test-integrations-xcodebuild` for clarity, reflecting its focus on SPM packages using xcodebuild. Adjusted job dependencies accordingly.

* Update SPM project option handling in sentry-xcodebuild.sh to accept a value instead of a boolean flag, improving flexibility in script usage.

* Add default working directory to unit test workflow configuration for improved test execution.

* Fix call for --spm-project to use missing param

* Inherit secrets in the 3rd-party integrations workflow

* Enhance unit test workflow by specifying working directory for code coverage and enable code coverage for SPM projects in the build script.

* diable slather for spm xcodebuild, as we don't have xcodeproj files

* dont upload codecov

* bump to 18.5

* bump rest to 18.5

* Update artifact naming in unit test workflow to include scheme for better identification and no re-uploading atrifacts with same name

* use working dir in Run CI Diagnostics

* Update name groupings

* UPdate name job grouping

* update naming

* trigger 3rd-party integration tests on source changes

* reduce number of runs

* test third-party integrations against pre-build artefacts instead of current release

* Only build one static target

* handle local artifacts in shared workflow

* fix path

* build sim slice

* use inputs.working_directory  for raw logs and archiving test results

* add build-xcframeworks to required check

* remove install + create (like on main)

* revert SKIP_SWIFTLINT

* add simulatorAndmacOSOnly to build-xcframework-local.sh

* use sed intead of swift package edit

swift package edit would pull in all dependencies, which would fail on release

* include all related scripts to file filter

* minor improvements

* remove unneeded scripts dir argument

* don’t install slather for som build

* only run spm tests, revert changes to shared tests workflow and build script

* use macOSOnly

* Remove 3rd-party-integrations filter from unit test in file-filters.yml

---------

Co-authored-by: Denis Andrasec &lt;denrase@gmail.com&gt;
diff --git a/.github/file-filters.yml b/.github/file-filters.yml
@@ -25,7 +25,6 @@ run_unit_tests_for_prs: &run_unit_tests_for_prs
   - "SentryTestUtils/**"
   - "SentryTestUtilsDynamic/**"
   - "SentryTestUtilsTests/**"
-  - "3rd-party-integrations/**"
 
   # GH Actions
   - ".github/workflows/test.yml"
@@ -528,3 +527,21 @@ run_size_analysis_for_prs: &run_size_analysis_for_prs
   # Build configuration
   - "Makefile"
   - "Brewfile*"
+
+run_3rd_party_integrations_tests_for_prs: &run_3rd_party_integrations_tests_for_prs
+  - "Sources/**"
+  - "3rd-party-integrations/**"
+
+  # GH Actions
+  - ".github/workflows/test-3rd-party-integrations.yml"
+  - ".github/file-filters.yml"
+
+  # Scripts
+  - "scripts/ci-select-xcode.sh"
+  - "scripts/ci-utils.sh"
+  - "scripts/ci-diagnostics.sh"
+  - "scripts/prepare-package.sh"
+  - "scripts/build-xcframework-local.sh"
+
+  # Project files
+  - "Package*.swift"
diff --git a/.github/workflows/test-3rd-party-integrations.yml b/.github/workflows/test-3rd-party-integrations.yml
@@ -0,0 +1,132 @@
+name: Test 3rd Party Integrations
+on:
+  push:
+    branches:
+      - main
+      - release/**
+
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+
+# Concurrency configuration:
+# - We use workflow-specific concurrency groups to allow independent test runs across different workflows
+#   while preventing multiple runs of the same test suite on the same branch/commit.
+# - For pull requests, we cancel in-progress runs when new commits are pushed to save CI resources
+#   and provide faster feedback on the latest changes.
+# - For main branch pushes and scheduled runs, we never cancel in-progress runs to ensure the complete
+#   test suite always finishes, maintaining the integrity of our main branch quality gates.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  ready-to-merge-gate:
+    name: Ready-to-merge gate
+    uses: ./.github/workflows/ready-to-merge-workflow.yml
+
+  # This job detects if the PR contains changes that require running tests for 3rd-party integrations.
+  # If yes, the job will output a flag that will be used by the next job to run the tests for 3rd-party integrations.
+  # If no, the job will output a flag that will be used by the next job to skip running the tests for 3rd-party integrations.
+  # At the end of this workflow, we run a check that validates that either all tests for 3rd-party integrations passed or were
+  # called unit-tests-required-check.
+  files-changed:
+    name: Detect File Changes
+    runs-on: ubuntu-latest
+    needs: ready-to-merge-gate
+    # Map a step output to a job output
+    outputs:
+      run_3rd_party_integrations_tests_for_prs: ${{ steps.changes.outputs.run_3rd_party_integrations_tests_for_prs }}
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+      - name: Get changed files
+        id: changes
+        uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        with:
+          token: ${{ github.token }}
+          filters: .github/file-filters.yml
+
+  # Build xcframeworks from source code once for all integration tests.
+  # This ensures tests use the current source code instead of the latest GitHub release.
+  # We only build the Static variant since 3rd-party integrations only use the "Sentry" product.
+  # Intentionally skipped on release branches.
+  build-xcframeworks:
+    name: Build XCFrameworks
+    needs: files-changed
+    if: startsWith(github.ref, 'refs/heads/release/') == false && (github.event_name != 'pull_request' || needs.files-changed.outputs.run_3rd_party_integrations_tests_for_prs == 'true')
+    runs-on: ["ghcr.io/cirruslabs/macos-runner:sequoia", "runner_group_id:10"]
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+      - name: Select Xcode
+        run: ./scripts/ci-select-xcode.sh 16.4
+      - name: Build XCFramework (Static)
+        run: ./scripts/build-xcframework-local.sh macOSOnly StaticOnly --not-signed
+      - name: Upload XCFrameworks
+        uses: actions/upload-artifact@v6
+        with:
+          name: xcframeworks-for-3rd-party-integration-tests
+          path: "XCFrameworkBuildPath/*.xcframework.zip"
+          retention-days: 1
+
+  # SPM tests for all 3rd-party integrations
+  test-integrations-spm:
+    name: SPM Tests | ${{matrix.integration_dir}}
+    needs: [files-changed, build-xcframeworks]
+    if: startsWith(github.ref, 'refs/heads/release/') == false && (github.event_name != 'pull_request' || needs.files-changed.outputs.run_3rd_party_integrations_tests_for_prs == 'true')
+    runs-on: ["ghcr.io/cirruslabs/macos-runner:sequoia", "runner_group_id:10"]
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - integration_dir: SentrySwiftLog
+          - integration_dir: SentrySwiftyBeaver
+          - integration_dir: SentryCocoaLumberjack
+          - integration_dir: SentryPulse
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+      - name: Select Xcode
+        run: ./scripts/ci-select-xcode.sh 16.4
+      - name: Download XCFrameworks
+        uses: actions/download-artifact@v7
+        with:
+          name: xcframeworks-for-3rd-party-integration-tests
+      - name: Modify Package.swift to use local xcframeworks
+        run: ./scripts/prepare-package.sh --package-file Package.swift --is-pr true --remove-duplicate true --change-path true
+      - name: Use local sentry-cocoa
+        working-directory: 3rd-party-integrations/${{matrix.integration_dir}}
+        run: |
+          sed -i '' 's|\.package(url: "https://github\.com/getsentry/sentry-cocoa", from: "[^"]*")|.package(name: "sentry-cocoa", path: "../..")|g' Package.swift
+      - name: Run SPM Tests
+        working-directory: 3rd-party-integrations/${{matrix.integration_dir}}
+        run: swift test
+      - name: Archiving Raw Logs
+        uses: actions/upload-artifact@v6
+        if: ${{ failure() || cancelled() }}
+        with:
+          name: raw-output-${{matrix.integration_dir}}-integration
+          path: |
+            3rd-party-integrations/${{matrix.integration_dir}}/.build/**/*.log
+      - name: Run CI Diagnostics
+        if: failure()
+        run: ./scripts/ci-diagnostics.sh
+
+  unit-tests-required-check:
+    needs:
+      [
+        ready-to-merge-gate,
+        files-changed,
+        build-xcframeworks,
+        test-integrations-spm,
+      ]
+    name: 3rd Party Integration Tests - Required Check
+    # This is necessary since a failed/skipped dependent job would cause this job to be skipped
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      # If any jobs we depend on fails gets cancelled or times out, this job will fail.
+      # Skipped jobs are not considered failures.
+      - name: Check for failures
+        if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
+        run: |
+          echo "One of the 3rd party integration test jobs has failed." && exit 1
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -360,134 +360,6 @@ jobs:
             device: "Apple Vision Pro"
             timeout: 30
 
-  # This will be replaced once #6945 is merged.
-  swiftlog-integration-unit-tests:
-    name: SentrySwiftLog Unit Tests
-    if: startsWith(github.ref, 'refs/heads/release/') == false && (github.event_name != 'pull_request' || needs.files-changed.outputs.run_unit_tests_for_prs == 'true')
-    needs: files-changed
-    runs-on: ["ghcr.io/cirruslabs/macos-runner:sequoia", "runner_group_id:10"]
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Select Xcode
-        run: ./scripts/ci-select-xcode.sh 16.4
-
-      - name: Setup local sentry-cocoa dependency
-        working-directory: 3rd-party-integrations/SentrySwiftLog
-        run: swift package edit sentry-cocoa --path ../..
-
-      - name: Run SwiftLog tests
-        working-directory: 3rd-party-integrations/SentrySwiftLog
-        run: swift test
-
-      - name: Archiving Raw Logs
-        uses: actions/upload-artifact@v6
-        if: ${{ failure() || cancelled() }}
-        with:
-          name: raw-output-swiftlog-integration
-          path: |
-            3rd-party-integrations/SentrySwiftLog/.build/**/*.log
-
-      - name: Run CI Diagnostics
-        if: failure()
-        run: ./scripts/ci-diagnostics.sh
-
-  # This will be replaced once #6945 is merged.
-  swiftybeaver-integration-unit-tests:
-    name: SentrySwiftyBeaver Unit Tests
-    if: startsWith(github.ref, 'refs/heads/release/') == false && (github.event_name != 'pull_request' || needs.files-changed.outputs.run_unit_tests_for_prs == 'true')
-    needs: files-changed
-    runs-on: ["ghcr.io/cirruslabs/macos-runner:sequoia", "runner_group_id:10"]
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Select Xcode
-        run: ./scripts/ci-select-xcode.sh 16.4
-
-      - name: Setup local sentry-cocoa dependency
-        working-directory: 3rd-party-integrations/SentrySwiftyBeaver
-        run: swift package edit sentry-cocoa --path ../..
-
-      - name: Run SwiftyBeaver tests
-        working-directory: 3rd-party-integrations/SentrySwiftyBeaver
-        run: swift test
-
-      - name: Archiving Raw Logs
-        uses: actions/upload-artifact@v6
-        if: ${{ failure() || cancelled() }}
-        with:
-          name: raw-output-swiftybeaver-integration
-          path: |
-            3rd-party-integrations/SentrySwiftyBeaver/.build/**/*.log
-
-      - name: Run CI Diagnostics
-        if: failure()
-        run: ./scripts/ci-diagnostics.sh
-
-  # This will be replaced once #6945 is merged.
-  cocoalumberjack-integration-unit-tests:
-    name: SentryCocoaLumberjack Unit Tests
-    if: startsWith(github.ref, 'refs/heads/release/') == false && (github.event_name != 'pull_request' || needs.files-changed.outputs.run_unit_tests_for_prs == 'true')
-    needs: files-changed
-    runs-on: ["ghcr.io/cirruslabs/macos-runner:sequoia", "runner_group_id:10"]
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Select Xcode
-        run: ./scripts/ci-select-xcode.sh 16.4
-
-      - name: Setup local sentry-cocoa dependency
-        working-directory: 3rd-party-integrations/SentryCocoaLumberjack
-        run: swift package edit sentry-cocoa --path ../..
-
-      - name: Run CocoaLumberjack tests
-        working-directory: 3rd-party-integrations/SentryCocoaLumberjack
-        run: swift test
-
-      - name: Archiving Raw Logs
-        uses: actions/upload-artifact@v6
-        if: ${{ failure() || cancelled() }}
-        with:
-          name: raw-output-cocoalumberjack-integration
-          path: |
-            3rd-party-integrations/SentryCocoaLumberjack/.build/**/*.log
-
-      - name: Run CI Diagnostics
-        if: failure()
-        run: ./scripts/ci-diagnostics.sh
-
-  # This will be replaced once #6945 is merged.
-  pulse-integration-unit-tests:
-    name: SentryPulse Unit Tests
-    if: startsWith(github.ref, 'refs/heads/release/') == false && (github.event_name != 'pull_request' || needs.files-changed.outputs.run_unit_tests_for_prs == 'true')
-    needs: files-changed
-    runs-on: ["ghcr.io/cirruslabs/macos-runner:sequoia", "runner_group_id:10"]
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Select Xcode
-        run: ./scripts/ci-select-xcode.sh 16.4
-
-      - name: Setup local sentry-cocoa dependency
-        working-directory: 3rd-party-integrations/SentryPulse
-        run: swift package edit sentry-cocoa --path ../..
-
-      - name: Run Pulse tests
-        working-directory: 3rd-party-integrations/SentryPulse
-        run: swift test
-
-      - name: Archiving Raw Logs
-        uses: actions/upload-artifact@v6
-        if: ${{ failure() || cancelled() }}
-        with:
-          name: raw-output-pulse-integration
-          path: |
-            3rd-party-integrations/SentryPulse/.build/**/*.log
-
-      - name: Run CI Diagnostics
-        if: failure()
-        run: ./scripts/ci-diagnostics.sh
-
   # This check validates that either all unit tests passed or were skipped, which allows us
   # to make unit tests a required check with only running the unit tests when required.
   # So, we don't have to run unit tests, for example, for Changelog or ReadMe changes.
@@ -499,10 +371,6 @@ jobs:
         build-test-server,
         distribution-tests,
         unit-tests,
-        swiftlog-integration-unit-tests,
-        swiftybeaver-integration-unit-tests,
-        cocoalumberjack-integration-unit-tests,
-        pulse-integration-unit-tests,
         ready-to-merge-gate,
         unit-tests-with-test-server,
       ]
