chore(ci): Add required checks for benchmarking (#5996)

Author: philprime

.github/file-filters.yml

@@ -65,6 +65,32 @@ run_api_stability_for_prs: &run_api_stability_for_prs # API-related code
   - "sdk_api.json"
   - "sdk_api_v9.json"
 
+run_benchmarking_for_prs: &run_benchmarking_for_prs
+  - "Sources/**"
+
+  # Benchmarking implementation
+  - "Samples/iOS-Swift/**"
+  - ".sauce/benchmarking-config.yml"
+  - "fastlane/**"
+
+  # GH Actions
+  - ".github/workflows/benchmarking.yml"
+  - ".github/workflows/build-xcframework-variant-slices.yml"
+  - ".github/workflows/assemble-xcframework-variant.yml"
+  - ".github/file-filters.yml"
+
+  # Scripts
+  - "scripts/ci-select-xcode.sh"
+  - "scripts/ci-diagnostics.sh"
+  - "scripts/build-xcframework-slice.sh"
+  - "scripts/assemble-xcframework.sh"
+
+  # Project files
+  - "Samples/iOS-Swift/iOS-Swift.yml"
+  - "Samples/iOS-Swift/iOS-Swift.xcconfig"
+  - "Samples/iOS-Swift/iOS-SwiftClip.xcconfig"
+  - "Samples/iOS-Swift/iOS-Benchmarking.xcconfig"
+
 run_test_cross_platform_for_prs: &run_test_cross_platform_for_prs
   - "Sources/**"
 

.github/workflows/benchmarking.yml

@@ -5,25 +5,6 @@ on:
       - main
 
   pull_request:
-    paths:
-      # test changes to Sentry SDK sources
-      - "Sources/**"
-
-      # test changes to benchmarking implementation
-      - "Samples/iOS-Swift/**"
-      - ".github/workflows/benchmarking.yml"
-      - ".sauce/benchmarking-config.yml"
-      - "fastlane/**"
-      - "scripts/ci-select-xcode.sh"
-      - "scripts/ci-diagnostics.sh"
-      - "Samples/iOS-Swift/iOS-Swift.yml"
-      - "Samples/iOS-Swift/iOS-Swift.xcconfig"
-      - "Samples/iOS-Swift/iOS-SwiftClip.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"
 
 # Concurrency configuration:
 # - We use workflow-specific concurrency groups to prevent multiple benchmark runs on the same code,
@@ -37,8 +18,25 @@ concurrency:
   cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 
 jobs:
+  files-changed:
+    name: Detect File Changes
+    runs-on: ubuntu-latest
+    outputs:
+      run_benchmarking_for_prs: ${{ steps.changes.outputs.run_benchmarking_for_prs }}
+    steps:
+      - uses: actions/checkout@v5
+      - name: Get changed files
+        id: changes
+        uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        with:
+          token: ${{ github.token }}
+          filters: .github/file-filters.yml
+
   build-benchmark-test-target:
     name: Build App and Test Runner
+    # Run the job only for PRs with related changes or non-PR events.
+    if: github.event_name != 'pull_request' || needs.files-changed.outputs.run_benchmarking_for_prs == 'true'
+    needs: files-changed
     runs-on: macos-14
     steps:
       - uses: actions/checkout@v5
@@ -104,8 +102,14 @@ jobs:
 
   run-ui-tests-with-sauce:
     name: Run Benchmarks ${{matrix.suite}}
+    # Run the job only for PRs with related changes or non-PR events.
+    if: github.event_name != 'pull_request' || needs.files-changed.outputs.run_benchmarking_for_prs == 'true'
     runs-on: ubuntu-latest
-    needs: build-benchmark-test-target
+    needs:
+      [
+        files-changed,
+        build-benchmark-test-target,
+      ]
     strategy:
       fail-fast: false
       matrix:
@@ -195,3 +199,22 @@ jobs:
       - name: Run CI Diagnostics
         if: failure()
         run: ./scripts/ci-diagnostics.sh
+
+  benchmarking-required-check:
+    needs:
+      [
+        files-changed,
+        build-benchmark-test-target,
+        run-ui-tests-with-sauce,
+      ]
+    name: Benchmarking
+    # 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 benchmark jobs has failed." && exit 1