iOS/.github/workflows/ci.yml

name: CI

permissions:
  contents: read
  pull-requests: write

on:
  pull_request:
  push:
    branches:
      - main

env:
  DEVELOPER_DIR: /Applications/Xcode_26.2.app/Contents/Developer
  FASTLANE_SKIP_UPDATE_CHECK: true
  FASTLANE_XCODE_LIST_TIMEOUT: 80
  FASTLANE_XCODEBUILD_SETTINGS_TIMEOUT: 80
  HOMEBREW_NO_INSTALL_CLEANUP: TRUE
  BUNDLE_PATH: vendor/bundle

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      - uses: ruby/setup-ruby@09a7688d3b55cf0e976497ff046b70949eeaccfd  # v1.288.0
        with:
          ruby-version: "3.1"
          bundler-cache: true
      - name: YamlLint
        run: yamllint --strict --format github .
      - name: RuboCop
        run: bundle exec rubocop --format github
      - name: SwiftLint
        run: |
          docker run --rm -v `pwd`:`pwd` -w `pwd` \
            ghcr.io/realm/swiftlint:0.54.0 \
            swiftlint lint --strict --config .swiftlint.yml --reporter github-actions-logging
      - name: SwiftFormat
        run: |
          docker run --rm -v `pwd`:`pwd` -w `pwd` \
            ghcr.io/nicklockwood/swiftformat:0.53.1 \
            --lint --config .swiftformat .

  check-swiftlint-disables:
    needs: lint
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2

      - name: Scan for `swiftlint:disable` in PR diff
        id: scan
        continue-on-error: false
        run: |
          git fetch origin main:refs/remotes/origin/main
          DISABLE_LINES=$(git diff origin/main -- '*.swift' | grep -E '^\+.*// swiftlint:disable' || true)
          echo "disable_lines<<EOF" >> $GITHUB_OUTPUT
          echo "$DISABLE_LINES" >> $GITHUB_OUTPUT
          echo "EOF" >> $GITHUB_OUTPUT

      - name: Comment on PR if `swiftlint:disable` is found
        if: steps.scan.outputs.disable_lines != ''
        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405  # v2.9.4
        with:
          header: swiftlint-disable-check
          message: |
            ⚠️ **SwiftLint disabled in this PR**

            The following added lines contain `// swiftlint:disable`. Please verify this is necessary.

  check-unused-strings:
    needs: lint
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2

      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v5.3.0
        with:
          python-version: '3.x'

      - name: Detect unused L10n strings
        id: detect
        continue-on-error: true
        run: |
          OUTPUT=$(python3 Tools/detect_unused_strings.py 2>&1 || true)
          echo "output<<EOF" >> $GITHUB_OUTPUT
          echo "$OUTPUT" >> $GITHUB_OUTPUT
          echo "EOF" >> $GITHUB_OUTPUT

          # Check if any unused strings were found
          if echo "$OUTPUT" | grep -q "Total unused:"; then
            COUNT=$(echo "$OUTPUT" | grep "Total unused:" | grep -oE '[0-9]+')
            echo "has_unused=true" >> $GITHUB_OUTPUT
            echo "count=$COUNT" >> $GITHUB_OUTPUT
          else
            echo "has_unused=false" >> $GITHUB_OUTPUT
            echo "count=0" >> $GITHUB_OUTPUT
          fi

      - name: Comment on PR if unused strings are found
        if: steps.detect.outputs.has_unused == 'true'
        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405  # v2.9.4
        with:
          header: unused-strings-check
          message: |
            ⚠️ **Unused L10n strings detected**

            Found **${{ steps.detect.outputs.count }}** unused localization strings in the codebase.

            <details>
            <summary>Click to see details</summary>

            ```
            ${{ steps.detect.outputs.output }}
            ```

            </details>

            To clean up these strings, manually remove them from the `Localizable.strings` files
            and regenerate `Strings.swift` using SwiftGen.

  test:
    needs: check-swiftlint-disables
    runs-on: macos-15
    timeout-minutes: 45
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2

      - uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306  # v5.0.3
        name: "Cache: Pods"
        id: cache_pods
        with:
          path: |
            Pods
            Tools/MaterialDesignIcons.ttf
            Tools/MaterialDesignIcons.json
          key: >-
            ${{ runner.os }}-pods-${{ env.DEVELOPER_DIR }}-
            ${{ hashFiles('**/Gemfile.lock', '**/Podfile.lock', 'Tools/BuildMaterialDesignIconsFont.sh') }}

      - uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306  # v5.0.3
        name: "Cache: Gems"
        id: cache_gems
        with:
          path: vendor/bundle
          key: >-
            ${{ runner.os }}-gems-${{ env.ImageVersion }}-${{ env.DEVELOPER_DIR }}-${{ hashFiles('**/Gemfile.lock') }}

      - name: Install Brews
        # right now, we don't need anything from brew for tests, so save some time
        if: ${{ false }}
        run: brew bundle

      - name: Install Gems
        if: steps.cache_gems.outputs.cache-hit != 'true'
        run: bundle install --jobs 4 --retry 3

      - name: Install Pods Release
        if: steps.cache_pods.outputs.cache-hit != 'true'
        run: bundle exec pod install --repo-update

      - name: Run tests
        run: bundle exec fastlane test

      - uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de  # v5.5.2
        name: "Upload Code Coverage"
        with:
          xcode: true
          xcode_archive_path: fastlane/test_output/Tests-Unit.xcresult

      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f  # v6.0.0
        name: "Upload Test Logs"
        if: ${{ always() }}
        with:
          name: test-logs
          path: |
            ~/Library/Logs/DiagnosticReports
            ~/Library/Developer/Xcode/DerivedData/HomeAssistant-*/Logs/Test
            ~/Library/Logs/scan

      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f  # v6.0.0
        name: "Upload Simulator App"
        with:
          name: ios-simulator
          path: ~/Library/Developer/Xcode/DerivedData/HomeAssistant-*/Build/Products/Debug-iphonesimulator/*.app

  size:
    needs: check-swiftlint-disables
    if: |
      github.event_name == 'pull_request' &&
      github.event.pull_request.head.repo.full_name == 'home-assistant/iOS'
    runs-on: macos-15
    timeout-minutes: 45
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      - uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306  # v4.6.2
        name: "Cache: Pods"
        id: cache_pods
        with:
          path: |
            Pods
            Tools/MaterialDesignIcons.ttf
            Tools/MaterialDesignIcons.json
          key: >-
            ${{ runner.os }}-pods-${{ env.DEVELOPER_DIR }}-
            ${{ hashFiles('**/Gemfile.lock', '**/Podfile.lock', 'Tools/BuildMaterialDesignIconsFont.sh') }}

      - uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306  # v5.0.3
        name: "Cache: Gems"
        id: cache_gems
        with:
          path: vendor/bundle
          key: >-
            ${{ runner.os }}-gems-${{ env.ImageVersion }}-${{ env.DEVELOPER_DIR }}-${{ hashFiles('**/Gemfile.lock') }}

      - name: Install Brews
        # right now, we don't need anything from brew for sizing, so save some time
        if: ${{ false }}
        run: brew bundle

      - name: Install Gems
        if: steps.cache_gems.outputs.cache-hit != 'true'
        run: bundle install --jobs 4 --retry 3

      - name: Install Pods Release
        if: steps.cache_pods.outputs.cache-hit != 'true'
        run: bundle exec pod install --repo-update

      - name: Build app
        run: bundle exec fastlane ios size
        env:
          P12_KEY_DISTRIBUTION: ${{ secrets.P12_KEY_DISTRIBUTION }}
          P12_VALUE_DISTRIBUTION: ${{ secrets.P12_VALUE_DISTRIBUTION }}
          P12_KEY_MAC_DEVELOPER_ID: ${{ secrets.P12_KEY_MAC_DEVELOPER_ID }}
          P12_KEY_MAC_DEVELOPER_INSTALLER: ${{ secrets.P12_KEY_MAC_DEVELOPER_INSTALLER }}
          P12_VALUE_MAC_DEVELOPER_ID: ${{ secrets.P12_VALUE_MAC_DEVELOPER_ID }}
          P12_VALUE_MAC_DEVELOPER_INSTALLER: ${{ secrets.P12_VALUE_MAC_DEVELOPER_INSTALLER }}
          EMERGE_API_TOKEN: ${{ secrets.EMERGE_API_TOKEN }}
          EMERGE_REPO_NAME: ${{ github.repository }}
          EMERGE_PR_NUMBER: ${{ github.event.number }}
          EMERGE_SHA: ${{ github.event.pull_request.head.sha }}
          EMERGE_BASE_SHA: ${{ github.event.pull_request.base.sha }}
          HOMEASSISTANT_APP_STORE_CONNECT_PASSWORD: ${{ secrets.HOMEASSISTANT_APP_STORE_CONNECT_PASSWORD }}
          HOMEASSISTANT_APPLE_ID: ${{ secrets.HOMEASSISTANT_APPLE_ID }}
          HOMEASSISTANT_FASTLANE_SESSION: ${{ secrets.HOMEASSISTANT_FASTLANE_SESSION }}