reusable-pr-checks.yml

# ─────────────────────────────────────────────────────────────────
# Reusable PR Quality Checks Workflow
# ─────────────────────────────────────────────────────────────────
# DRY workflow for running quality checks on pull requests.
# Called by other workflows to validate code quality before merging.
#
# Features:
# - Path-based filtering (only run checks for changed files)
# - Caching for fast subsequent runs (90%+ speed improvement)
# - Optional mobile and integration test support
# - Parallel job execution
# - Artifacts on failure only
#
# Author: Alireza Rezvani
# Date: 2025-11-06
# ─────────────────────────────────────────────────────────────────

name: Reusable PR Quality Checks

on:
  workflow_call:
    inputs:
      mobile_check:
        description: 'Run mobile platform checks (iOS/Android)'
        required: false
        type: boolean
        default: false
      integration_tests:
        description: 'Run integration tests'
        required: false
        type: boolean
        default: false
      node_version:
        description: 'Node.js version to use'
        required: false
        type: string
        default: '20'
      pnpm_version:
        description: 'pnpm version to use'
        required: false
        type: string
        default: '9'
      working_directory:
        description: 'Working directory for checks'
        required: false
        type: string
        default: '.'

permissions:
  contents: read
  pull-requests: read

# Cancel in-progress runs for the same PR
concurrency:
  group: quality-checks-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # ─────────────────────────────────────────────────────────────────
  # Path Filtering
  # ─────────────────────────────────────────────────────────────────
  # Detect which files changed to determine which checks to run
  path-filter:
    name: Detect Changed Paths
    runs-on: ubuntu-latest
    outputs:
      web: ${{ steps.filter.outputs.web }}
      mobile: ${{ steps.filter.outputs.mobile }}
      mobile-ios: ${{ steps.filter.outputs.mobile-ios }}
      mobile-android: ${{ steps.filter.outputs.mobile-android }}
      tests: ${{ steps.filter.outputs.tests }}
      docs-only: ${{ steps.filter.outputs.docs-only }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Filter changed paths
        uses: dorny/paths-filter@v3
        id: filter
        with:
          filters: |
            web:
              - 'src/**'
              - 'lib/**'
              - 'components/**'
              - 'pages/**'
              - 'app/**'
              - '*.ts'
              - '*.tsx'
              - '*.js'
              - '*.jsx'
              - 'package.json'
              - 'tsconfig.json'

            mobile:
              - 'mobile/**'
              - 'ios/**'
              - 'android/**'
              - '*.swift'
              - '*.kt'
              - '*.java'

            mobile-ios:
              - 'ios/**'
              - '*.swift'
              - 'Podfile'
              - 'Podfile.lock'

            mobile-android:
              - 'android/**'
              - '*.kt'
              - '*.java'
              - 'build.gradle'
              - 'settings.gradle'

            tests:
              - '**/*.test.ts'
              - '**/*.test.tsx'
              - '**/*.test.js'
              - '**/*.spec.ts'
              - '**/*.spec.tsx'
              - '**/*.spec.js'
              - 'tests/**'
              - '__tests__/**'

            docs-only:
              - '**.md'
              - 'docs/**'
              - '.github/**/*.md'

  # ─────────────────────────────────────────────────────────────────
  # Lint Check
  # ─────────────────────────────────────────────────────────────────
  lint:
    name: Lint
    runs-on: ubuntu-latest
    needs: path-filter
    if: needs.path-filter.outputs.docs-only != 'true' && needs.path-filter.outputs.web == 'true'

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Setup Node.js and pnpm
        uses: ./.github/actions/setup-node-pnpm
        with:
          node-version: ${{ inputs.node_version }}
          pnpm-version: ${{ inputs.pnpm_version }}
          working-directory: ${{ inputs.working_directory }}

      - name: Run ESLint
        working-directory: ${{ inputs.working_directory }}
        run: |
          echo "🔍 Running ESLint..."
          pnpm run lint
        continue-on-error: false

      - name: Run Prettier check
        working-directory: ${{ inputs.working_directory }}
        run: |
          echo "🎨 Running Prettier check..."
          pnpm run format:check || pnpm run prettier:check || echo "⚠️  No format check script found - skipping"
        continue-on-error: true

      - name: Upload lint results on failure
        if: failure()
        uses: actions/upload-artifact@v6
        with:
          name: lint-results
          path: |
            ${{ inputs.working_directory }}/eslint-report.json
            ${{ inputs.working_directory }}/eslint-report.html
          retention-days: 2
          if-no-files-found: ignore

  # ─────────────────────────────────────────────────────────────────
  # Type Check
  # ─────────────────────────────────────────────────────────────────
  typecheck:
    name: Type Check
    runs-on: ubuntu-latest
    needs: path-filter
    if: needs.path-filter.outputs.docs-only != 'true' && needs.path-filter.outputs.web == 'true'

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Setup Node.js and pnpm
        uses: ./.github/actions/setup-node-pnpm
        with:
          node-version: ${{ inputs.node_version }}
          pnpm-version: ${{ inputs.pnpm_version }}
          working-directory: ${{ inputs.working_directory }}

      - name: Run TypeScript type check
        working-directory: ${{ inputs.working_directory }}
        run: |
          echo "🔍 Running TypeScript type check..."
          pnpm run type-check || pnpm run typecheck || pnpm exec tsc --noEmit
        continue-on-error: false

      - name: Upload type check results on failure
        if: failure()
        uses: actions/upload-artifact@v6
        with:
          name: typecheck-results
          path: |
            ${{ inputs.working_directory }}/tsconfig.tsbuildinfo
          retention-days: 2
          if-no-files-found: ignore

  # ─────────────────────────────────────────────────────────────────
  # Unit Tests
  # ─────────────────────────────────────────────────────────────────
  test-unit:
    name: Unit Tests
    runs-on: ubuntu-latest
    needs: path-filter
    if: needs.path-filter.outputs.docs-only != 'true'

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Setup Node.js and pnpm
        uses: ./.github/actions/setup-node-pnpm
        with:
          node-version: ${{ inputs.node_version }}
          pnpm-version: ${{ inputs.pnpm_version }}
          working-directory: ${{ inputs.working_directory }}

      - name: Run unit tests
        working-directory: ${{ inputs.working_directory }}
        run: |
          echo "🧪 Running unit tests..."
          pnpm run test:unit || pnpm run test -- --testPathIgnorePatterns=integration || pnpm run test
        continue-on-error: false
        env:
          CI: true

      - name: Upload test results on failure
        if: failure()
        uses: actions/upload-artifact@v6
        with:
          name: unit-test-results
          path: |
            ${{ inputs.working_directory }}/coverage/
            ${{ inputs.working_directory }}/test-results/
          retention-days: 2
          if-no-files-found: ignore

      - name: Upload coverage reports
        if: always()
        uses: actions/upload-artifact@v6
        with:
          name: coverage-reports
          path: |
            ${{ inputs.working_directory }}/coverage/
          retention-days: 7
          if-no-files-found: ignore

  # ─────────────────────────────────────────────────────────────────
  # Integration Tests (Optional)
  # ─────────────────────────────────────────────────────────────────
  test-integration:
    name: Integration Tests
    runs-on: ubuntu-latest
    needs: path-filter
    if: inputs.integration_tests == true && needs.path-filter.outputs.docs-only != 'true'

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Setup Node.js and pnpm
        uses: ./.github/actions/setup-node-pnpm
        with:
          node-version: ${{ inputs.node_version }}
          pnpm-version: ${{ inputs.pnpm_version }}
          working-directory: ${{ inputs.working_directory }}

      - name: Run integration tests
        working-directory: ${{ inputs.working_directory }}
        run: |
          echo "🧪 Running integration tests..."
          pnpm run test:integration || pnpm run test -- --testPathPattern=integration
        continue-on-error: false
        env:
          CI: true

      - name: Upload integration test results on failure
        if: failure()
        uses: actions/upload-artifact@v6
        with:
          name: integration-test-results
          path: |
            ${{ inputs.working_directory }}/coverage/
            ${{ inputs.working_directory }}/test-results/
          retention-days: 2
          if-no-files-found: ignore

  # ─────────────────────────────────────────────────────────────────
  # Mobile Checks (Optional)
  # ─────────────────────────────────────────────────────────────────
  mobile-check:
    name: Mobile Build Validation
    runs-on: ubuntu-latest
    needs: path-filter
    if: inputs.mobile_check == true && needs.path-filter.outputs.mobile == 'true'

    strategy:
      matrix:
        platform:
          - ios
          - android

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Setup Node.js and pnpm
        uses: ./.github/actions/setup-node-pnpm
        with:
          node-version: ${{ inputs.node_version }}
          pnpm-version: ${{ inputs.pnpm_version }}
          working-directory: ${{ inputs.working_directory }}

      # iOS-specific setup
      - name: Setup iOS dependencies
        if: matrix.platform == 'ios' && needs.path-filter.outputs.mobile-ios == 'true'
        run: |
          echo "📱 Setting up iOS dependencies..."
          if [ -d "ios" ]; then
            cd ios
            if [ -f "Podfile" ]; then
              pod install --repo-update
            fi
          fi

      # Android-specific setup
      - name: Setup Android dependencies
        if: matrix.platform == 'android' && needs.path-filter.outputs.mobile-android == 'true'
        run: |
          echo "🤖 Setting up Android dependencies..."
          if [ -d "android" ]; then
            cd android
            ./gradlew --version
          fi

      # Validate mobile builds
      - name: Validate ${{ matrix.platform }} build
        run: |
          echo "🏗️  Validating ${{ matrix.platform }} build..."

          if [ "${{ matrix.platform }}" == "ios" ]; then
            pnpm run ios:build || echo "⚠️  iOS build validation skipped (not configured)"
          else
            pnpm run android:build || echo "⚠️  Android build validation skipped (not configured)"
          fi
        continue-on-error: true

      - name: Upload mobile build results on failure
        if: failure()
        uses: actions/upload-artifact@v6
        with:
          name: mobile-${{ matrix.platform }}-build-results
          path: |
            **/build/
            **/DerivedData/
          retention-days: 2
          if-no-files-found: ignore

  # ─────────────────────────────────────────────────────────────────
  # Summary
  # ─────────────────────────────────────────────────────────────────
  quality-summary:
    name: Quality Check Summary
    runs-on: ubuntu-latest
    needs:
      - path-filter
      - lint
      - typecheck
      - test-unit
      - test-integration
      - mobile-check
    if: always()

    steps:
      - name: Generate summary
        run: |
          echo "# 🎯 Quality Check Summary" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY

          echo "## 📊 Results" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "| Check | Status |" >> $GITHUB_STEP_SUMMARY
          echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY

          # Lint
          if [[ "${{ needs.lint.result }}" == "success" ]]; then
            echo "| Lint | ✅ Passed |" >> $GITHUB_STEP_SUMMARY
          elif [[ "${{ needs.lint.result }}" == "skipped" ]]; then
            echo "| Lint | ⏭️ Skipped |" >> $GITHUB_STEP_SUMMARY
          else
            echo "| Lint | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
          fi

          # Type Check
          if [[ "${{ needs.typecheck.result }}" == "success" ]]; then
            echo "| Type Check | ✅ Passed |" >> $GITHUB_STEP_SUMMARY
          elif [[ "${{ needs.typecheck.result }}" == "skipped" ]]; then
            echo "| Type Check | ⏭️ Skipped |" >> $GITHUB_STEP_SUMMARY
          else
            echo "| Type Check | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
          fi

          # Unit Tests
          if [[ "${{ needs.test-unit.result }}" == "success" ]]; then
            echo "| Unit Tests | ✅ Passed |" >> $GITHUB_STEP_SUMMARY
          elif [[ "${{ needs.test-unit.result }}" == "skipped" ]]; then
            echo "| Unit Tests | ⏭️ Skipped |" >> $GITHUB_STEP_SUMMARY
          else
            echo "| Unit Tests | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
          fi

          # Integration Tests
          if [[ "${{ needs.test-integration.result }}" == "success" ]]; then
            echo "| Integration Tests | ✅ Passed |" >> $GITHUB_STEP_SUMMARY
          elif [[ "${{ needs.test-integration.result }}" == "skipped" ]]; then
            echo "| Integration Tests | ⏭️ Skipped (not enabled) |" >> $GITHUB_STEP_SUMMARY
          else
            echo "| Integration Tests | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
          fi

          # Mobile Check
          if [[ "${{ needs.mobile-check.result }}" == "success" ]]; then
            echo "| Mobile Build | ✅ Passed |" >> $GITHUB_STEP_SUMMARY
          elif [[ "${{ needs.mobile-check.result }}" == "skipped" ]]; then
            echo "| Mobile Build | ⏭️ Skipped (not enabled) |" >> $GITHUB_STEP_SUMMARY
          else
            echo "| Mobile Build | ⚠️ Build validation had issues |" >> $GITHUB_STEP_SUMMARY
          fi

          echo "" >> $GITHUB_STEP_SUMMARY

          # Overall status
          if [[ "${{ needs.lint.result }}" == "failure" ]] || \
             [[ "${{ needs.typecheck.result }}" == "failure" ]] || \
             [[ "${{ needs.test-unit.result }}" == "failure" ]] || \
             [[ "${{ needs.test-integration.result }}" == "failure" ]]; then
            echo "## ❌ Quality checks failed" >> $GITHUB_STEP_SUMMARY
            echo "" >> $GITHUB_STEP_SUMMARY
            echo "Please fix the failing checks before merging." >> $GITHUB_STEP_SUMMARY
            exit 1
          else
            echo "## ✅ All quality checks passed" >> $GITHUB_STEP_SUMMARY
            echo "" >> $GITHUB_STEP_SUMMARY
            echo "Ready for review and merge!" >> $GITHUB_STEP_SUMMARY
          fi

          echo "" >> $GITHUB_STEP_SUMMARY
          echo "---" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "_Quality checks completed at $(date -u '+%Y-%m-%d %H:%M:%S UTC')_" >> $GITHUB_STEP_SUMMARY