feat(ci): add expo doctor results as comment for PR

Author: yjose

.github/scripts/expo-doctor.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Run expo-doctor and capture output and exit code
+output=$(npx expo-doctor@latest 2>&1)
+exit_code=$?
+
+# Output file location
+output_file=".expo/expo-doctor.md"
+{
+  # Add summary based on exit code
+  if [ $exit_code -eq 0 ]; then
+    echo "✅ **Good news!** We ran Expo Doctor for this PR and everything looks good, Great job!" > "$output_file"
+  else
+    echo "❌ **Action Required:** We ran Expo Doctor for this PR and found some issues that need to be addressed. Please review the complete report below." > "$output_file"
+  fi
+
+  echo >> "$output_file"  # Add blank line
+  echo "\`\`\`shell" >> "$output_file"
+  echo "$output" >> "$output_file"
+  echo "\`\`\`" >> "$output_file"
+}
+
+# Show original output in terminal
+echo "$output"
+
+# Return the original exit code
+exit $exit_code

.github/workflows/expo-doctor.yml

@@ -27,6 +27,8 @@ jobs:
   doctor:
     name: Expo Doctor (expo)
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
 
     steps:
       - name: 📦 Checkout project repo
@@ -38,7 +40,17 @@ jobs:
         uses: ./.github/actions/setup-node-pnpm-install
 
       - name: Run prebuild
-        run: pnpm run prebuild ## we only need to run this to generate the badged icon in `.expo` folder
+        run: pnpm run prebuild
 
       - name: 🚑 Run Doctor Checks
-        run: rm -rf ios android && pnpm run doctor ## apprently the new update of expo will break if you already have ios and android folders in your project as they will show up a eas warning
+        run: |
+          chmod +x .github/scripts/expo-doctor.sh
+          rm -rf ios android
+          .github/scripts/expo-doctor.sh
+
+      - name: Add doctor report as comment on PR
+        if: github.event_name == 'pull_request' && always()
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: expo-doctor
+          path: .expo/expo-doctor.md