chore(ci): Add required check job for Testflight (#6037)

Author: philprime

.github/file-filters.yml

@@ -311,6 +311,21 @@ run_build_for_prs: &run_build_for_prs # Build-related code
   - "Makefile" # Make commands used for CI build setup
   - "Brewfile*" # Dependency installation affects build environment
 
+run_testflight_for_prs: &run_testflight_for_prs # Testflight-related code
+  - ".github/workflows/testflight.yml"
+
+run_testflight_for_pushes: &run_testflight_for_pushes # Testflight-related code
+  - "Sources/**"
+  - "Samples/iOS-Swift/**"
+
+  # GH Actions
+  - ".github/workflows/testflight.yml"
+  - ".github/file-filters.yml"
+
+  # Scripts
+  - "scripts/ci-select-xcode.sh"
+  - "scripts/ci-diagnostics.sh"
+
 run_check_package_diff_for_prs: &run_check_package_diff_for_prs # Package.swift diff checking
   # GH Actions
   - ".github/workflows/check-package-diff.yml"

.github/workflows/testflight.yml

@@ -5,18 +5,7 @@ on:
       - main
       - release/**
 
-    paths:
-      - "Sources/**"
-      - "Samples/iOS-Swift/**"
-      - ".github/workflows/testflight.yml"
-      - "fastlane/**"
-      - "scripts/ci-select-xcode.sh"
-      - "scripts/ci-diagnostics.sh"
-
   pull_request:
-    paths:
-      - ".github/workflows/testflight.yml"
-      - "scripts/ci-diagnostics.sh"
   workflow_dispatch:
 
 # Concurrency configuration:
@@ -31,7 +20,23 @@ concurrency:
   cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 
 jobs:
+  files-changed:
+    name: Detect File Changes
+    runs-on: ubuntu-latest
+    outputs:
+      run_testflight_for_changes: ${{ github.event_name == 'pull_request' && steps.changes.outputs.run_testflight_for_prs || steps.changes.outputs.run_testflight_for_pushes }}
+    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
+
   upload_to_testflight:
+    if: needs.files-changed.outputs.run_testflight_for_changes == 'true'
+    needs: files-changed
     name: Build and Upload iOS-Swift to Testflight
     runs-on: macos-15
     steps:
@@ -81,3 +86,24 @@ jobs:
       - name: Run CI Diagnostics
         if: failure()
         run: ./scripts/ci-diagnostics.sh
+
+  # This check validates that either upload_to_testflight passed or was skipped, which allows us
+  # to make testflight a required check with only running the upload_to_testflight when required.
+  # So, we don't have to run upload_to_testflight, for example, for unrelated changes.
+  testflight-required-check:
+    needs:
+      [
+        files-changed,
+        upload_to_testflight,
+      ]
+    name: Testflight
+    # 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 testflight jobs has failed." && exit 1