update: enhance GitHub Actions workflow to include testing steps and improve caching mechanism

Author: kroonen

.github/workflows/swift.yml

@@ -1,62 +1,92 @@
-# This workflow builds an iPhone app using Xcode
-name: Build iPhone App
+name: Build & Test iPhone App
 
 on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "main" ]
 
 jobs:
   build:
     runs-on: macos-latest
+    env:
+      XCODE_VERSION_PATH: "/Applications/Xcode_16.1.app"
+      WORKSPACE: "ophelia/ophelia.xcodeproj/project.xcworkspace"
+      SCHEME: "ophelia"
+      DESTINATION: "platform=iOS Simulator,name=iPhone 16,OS=18.1"
+      CACHE_KEY_PREFIX: "ophelia-xcode-cache"
 
     steps:
-      # Check out the repository
       - name: Check Out Code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
 
-      # Select Xcode 16.1
       - name: Select Xcode Version
-        run: sudo xcode-select -switch /Applications/Xcode_16.1.app
+        run: sudo xcode-select -switch $XCODE_VERSION_PATH
 
-      # Check Xcode version and list simulators
       - name: Debug Environment
         run: |
           echo "Xcode Version:"
           xcodebuild -version
           echo "Available Simulators:"
           xcrun simctl list
 
-      # Ensure DerivedData directory exists
-      - name: Ensure DerivedData Exists
-        run: mkdir -p ~/Library/Developer/Xcode/DerivedData
-
-      # Cache DerivedData
+      # Use a stable cache key to maximize cache hits based on the project files.
       - name: Cache DerivedData
         uses: actions/cache@v3
         with:
           path: ~/Library/Developer/Xcode/DerivedData
-          key: ${{ runner.os }}-xcode-${{ github.sha }}
+          key: ${{ env.CACHE_KEY_PREFIX }}-${{ runner.os }}-${{ hashFiles('ophelia/ophelia.xcodeproj/**', 'Package.resolved') }}
           restore-keys: |
-            ${{ runner.os }}-xcode-
+            ${{ env.CACHE_KEY_PREFIX }}-${{ runner.os }}-
 
-      # List project files for debugging
-      - name: List Project Directory
-        run: ls -R ophelia
-
-      # Build the app
       - name: Build App
         run: |
-          xcodebuild -workspace ophelia/ophelia.xcodeproj/project.xcworkspace \
-                     -scheme ophelia \
-                     -sdk iphonesimulator \
-                     -destination 'platform=iOS Simulator,name=iPhone 16,OS=18.1' \
-                     build
-
-      # Debug DerivedData if build fails
-      - name: Check Derived Data
+          set -o pipefail && xcodebuild \
+            -workspace "$WORKSPACE" \
+            -scheme "$SCHEME" \
+            -sdk iphonesimulator \
+            -destination "$DESTINATION" \
+            build | xcpretty
+        shell: bash
+
+      # Upload logs if build fails for debugging
+      - name: Upload Logs on Failure
         if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: build-logs
+          path: ~/Library/Logs/DiagnosticReports/
+
+  test:
+    runs-on: macos-latest
+    needs: build
+    env:
+      XCODE_VERSION_PATH: "/Applications/Xcode_16.1.app"
+      WORKSPACE: "ophelia/ophelia.xcodeproj/project.xcworkspace"
+      SCHEME: "ophelia"
+      DESTINATION: "platform=iOS Simulator,name=iPhone 16,OS=18.1"
+
+    steps:
+      - name: Check Out Code
+        uses: actions/checkout@v4
+
+      - name: Select Xcode Version
+        run: sudo xcode-select -switch $XCODE_VERSION_PATH
+
+      - name: Run Tests
         run: |
-          echo "DerivedData Directory:"
-          ls ~/Library/Developer/Xcode/DerivedData || echo "DerivedData not found"
+          set -o pipefail && xcodebuild \
+            -workspace "$WORKSPACE" \
+            -scheme "$SCHEME" \
+            -sdk iphonesimulator \
+            -destination "$DESTINATION" \
+            test | xcpretty
+        shell: bash
+
+      - name: Upload Test Results on Failure
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-logs
+          path: ~/Library/Logs/DiagnosticReports/