--- name: CI on: push: branches: [dev, beta, release] pull_request: merge_group: permissions: contents: read # actions/checkout for all jobs; individual jobs add their own scopes when they need to write env: DEFAULT_PYTHON: "3.11" PYUPGRADE_TARGET: "--py311-plus" concurrency: # yamllint disable-line rule:line-length group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} cancel-in-progress: true jobs: common: name: Create common environment runs-on: ubuntu-24.04 outputs: cache-key: ${{ steps.cache-key.outputs.key }} steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Generate cache-key id: cache-key run: echo key="${{ hashFiles('requirements.txt', 'requirements_dev.txt', 'requirements_test.txt', '.pre-commit-config.yaml') }}" >> $GITHUB_OUTPUT - name: Set up Python ${{ env.DEFAULT_PYTHON }} id: python uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version: ${{ env.DEFAULT_PYTHON }} - name: Restore Python virtual environment id: cache-venv uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: venv # yamllint disable-line rule:line-length key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-venv-${{ steps.cache-key.outputs.key }} - name: Set up uv # Only needed on cache miss to populate the venv. ``uv pip install`` # detects the activated venv via ``VIRTUAL_ENV`` so downstream jobs # that ``. venv/bin/activate`` see an identical layout. if: steps.cache-venv.outputs.cache-hit != 'true' uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 with: enable-cache: true # Pin uv version so the action does not have to fetch the # manifest from raw.githubusercontent.com on every cache # miss; that fetch flakes on Windows runners. version: "0.11.15" - name: Create Python virtual environment if: steps.cache-venv.outputs.cache-hit != 'true' run: | python -m venv venv . venv/bin/activate python --version uv pip install -r requirements.txt -r requirements_dev.txt -r requirements_test.txt pre-commit uv pip install -e . pylint: name: Check pylint runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.python-linters == 'true' steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Run pylint run: | . venv/bin/activate pylint -f parseable --persistent=n esphome - name: Suggested changes run: script/ci-suggest-changes if: always() ci-custom: name: Run script/ci-custom runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.core-ci == 'true' steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Register matcher run: echo "::add-matcher::.github/workflows/matchers/ci-custom.json" - name: Run script/ci-custom run: | . venv/bin/activate script/ci-custom.py script/build_codeowners.py --check script/build_language_schema.py --check script/generate-esp32-boards.py --check script/generate-rp2040-boards.py --check import-time: name: Check import esphome.__main__ time runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.import-time == 'true' steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Check import time against budget and write waterfall HAR run: | . venv/bin/activate script/check_import_time.py --check --har importtime.har - name: Upload waterfall HAR if: always() uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: import-time-waterfall path: importtime.har if-no-files-found: ignore retention-days: 14 device-builder: name: Test downstream esphome/device-builder runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.device-builder == 'true' steps: - name: Check out esphome (this PR) uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: path: esphome - name: Check out esphome/device-builder uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: repository: esphome/device-builder ref: main path: device-builder - name: Set up Python uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version: "3.13" - name: Set up uv # Mirrors the install shape device-builder's own CI uses # (esphome/device-builder#192): uv replaces pip for the # install step (order-of-magnitude faster on cold boots, # with its own wheel cache). actions/setup-python still # provides the interpreter. uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 with: enable-cache: true # Pin uv version so the action does not have to fetch the # manifest from raw.githubusercontent.com on every cache # miss; that fetch flakes on Windows runners. version: "0.11.15" - name: Install device-builder + esphome from PR # Install device-builder with its esphome + test extras # first so its pinned versions of pytest/etc. land, then # overlay the PR's esphome so the downstream tests run # against this PR's Python code. ``--system`` installs into # the runner's Python instead of a venv. run: | uv pip install --system -e './device-builder[esphome,test]' uv pip install --system -e ./esphome - name: Run device-builder pytest # ``-n auto`` runs under pytest-xdist (matches device-builder's # own CI). No ``--cov`` here -- this is purely a downstream # smoke check against this PR's esphome code. ``tests/e2e/slow`` # is excluded: those are real multi-minute toolchain compiles # (LibreTiny SDK clone, native ESP-IDF install) that device-builder # runs in its own dedicated jobs, not this smoke check. working-directory: device-builder run: pytest -q -n auto --maxfail=5 --durations=30 --no-cov --ignore=tests/benchmarks --ignore=tests/e2e/slow pytest: name: Run pytest strategy: fail-fast: false matrix: python-version: - "3.11" - "3.13" - "3.14" os: - ubuntu-latest - macOS-latest - windows-latest exclude: # Minimize CI resource usage # by only running the Python version # version used for docker images on Windows and macOS - python-version: "3.13" os: windows-latest - python-version: "3.13" os: macOS-latest runs-on: ${{ matrix.os }} needs: - common - determine-jobs if: needs.determine-jobs.outputs.core-ci == 'true' steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python id: restore-python uses: ./.github/actions/restore-python with: python-version: ${{ matrix.python-version }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Register matcher run: echo "::add-matcher::.github/workflows/matchers/pytest.json" - name: Run pytest if: matrix.os == 'windows-latest' run: | . ./venv/Scripts/activate.ps1 pytest -vv --cov-report=xml --tb=native --durations=30 -n auto tests --ignore=tests/integration/ - name: Run pytest if: matrix.os == 'ubuntu-latest' || matrix.os == 'macOS-latest' run: | . venv/bin/activate pytest -vv --cov-report=xml --tb=native --durations=30 -n auto tests --ignore=tests/integration/ - name: Upload coverage to Codecov uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354 # v6.0.1 with: token: ${{ secrets.CODECOV_TOKEN }} - name: Save Python virtual environment cache if: github.ref == 'refs/heads/dev' uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: venv key: ${{ runner.os }}-${{ steps.restore-python.outputs.python-version }}-venv-${{ needs.common.outputs.cache-key }} determine-jobs: name: Determine which jobs to run runs-on: ubuntu-24.04 needs: - common outputs: core-ci: ${{ steps.determine.outputs.core-ci }} integration-tests: ${{ steps.determine.outputs.integration-tests }} integration-test-buckets: ${{ steps.determine.outputs.integration-test-buckets }} clang-tidy: ${{ steps.determine.outputs.clang-tidy }} clang-tidy-mode: ${{ steps.determine.outputs.clang-tidy-mode }} clang-tidy-full-scan: ${{ steps.determine.outputs.clang-tidy-full-scan }} python-linters: ${{ steps.determine.outputs.python-linters }} import-time: ${{ steps.determine.outputs.import-time }} device-builder: ${{ steps.determine.outputs.device-builder }} native-idf: ${{ steps.determine.outputs.native-idf }} native-idf-components: ${{ steps.determine.outputs.native-idf-components }} changed-components: ${{ steps.determine.outputs.changed-components }} changed-components-with-tests: ${{ steps.determine.outputs.changed-components-with-tests }} directly-changed-components-with-tests: ${{ steps.determine.outputs.directly-changed-components-with-tests }} component-test-count: ${{ steps.determine.outputs.component-test-count }} changed-cpp-file-count: ${{ steps.determine.outputs.changed-cpp-file-count }} memory_impact: ${{ steps.determine.outputs.memory-impact }} cpp-unit-tests-run-all: ${{ steps.determine.outputs.cpp-unit-tests-run-all }} cpp-unit-tests-components: ${{ steps.determine.outputs.cpp-unit-tests-components }} component-test-batches: ${{ steps.determine.outputs.component-test-batches }} validate-only-components: ${{ steps.determine.outputs.validate-only-components }} benchmarks: ${{ steps.determine.outputs.benchmarks }} steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: # Fetch enough history to find the merge base fetch-depth: 2 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Restore components graph cache uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: .temp/components_graph.json key: components-graph-${{ hashFiles('esphome/components/**/*.py') }} - name: Determine which tests to run id: determine env: GH_TOKEN: ${{ github.token }} run: | . venv/bin/activate EXTRA_ARGS="" if [[ "${{ contains(github.event.pull_request.labels.*.name, 'ci-run-all') }}" == "true" ]]; then EXTRA_ARGS="--force-all" echo "::notice::ci-run-all label detected -- forcing every CI job to run" fi output=$(python script/determine-jobs.py $EXTRA_ARGS) echo "Test determination output:" echo "$output" | jq # Extract individual fields echo "core-ci=$(echo "$output" | jq -r '.core_ci')" >> $GITHUB_OUTPUT echo "integration-tests=$(echo "$output" | jq -r '.integration_tests')" >> $GITHUB_OUTPUT echo "integration-test-buckets=$(echo "$output" | jq -c '.integration_test_buckets')" >> $GITHUB_OUTPUT echo "clang-tidy=$(echo "$output" | jq -r '.clang_tidy')" >> $GITHUB_OUTPUT echo "clang-tidy-mode=$(echo "$output" | jq -r '.clang_tidy_mode')" >> $GITHUB_OUTPUT echo "clang-tidy-full-scan=$(echo "$output" | jq -r '.clang_tidy_full_scan')" >> $GITHUB_OUTPUT echo "python-linters=$(echo "$output" | jq -r '.python_linters')" >> $GITHUB_OUTPUT echo "import-time=$(echo "$output" | jq -r '.import_time')" >> $GITHUB_OUTPUT echo "device-builder=$(echo "$output" | jq -r '.device_builder')" >> $GITHUB_OUTPUT echo "native-idf=$(echo "$output" | jq -r '.native_idf')" >> $GITHUB_OUTPUT echo "native-idf-components=$(echo "$output" | jq -r '.native_idf_components')" >> $GITHUB_OUTPUT echo "changed-components=$(echo "$output" | jq -c '.changed_components')" >> $GITHUB_OUTPUT echo "changed-components-with-tests=$(echo "$output" | jq -c '.changed_components_with_tests')" >> $GITHUB_OUTPUT echo "directly-changed-components-with-tests=$(echo "$output" | jq -c '.directly_changed_components_with_tests')" >> $GITHUB_OUTPUT echo "component-test-count=$(echo "$output" | jq -r '.component_test_count')" >> $GITHUB_OUTPUT echo "changed-cpp-file-count=$(echo "$output" | jq -r '.changed_cpp_file_count')" >> $GITHUB_OUTPUT echo "memory-impact=$(echo "$output" | jq -c '.memory_impact')" >> $GITHUB_OUTPUT echo "cpp-unit-tests-run-all=$(echo "$output" | jq -r '.cpp_unit_tests_run_all')" >> $GITHUB_OUTPUT echo "cpp-unit-tests-components=$(echo "$output" | jq -c '.cpp_unit_tests_components')" >> $GITHUB_OUTPUT echo "component-test-batches=$(echo "$output" | jq -c '.component_test_batches')" >> $GITHUB_OUTPUT echo "validate-only-components=$(echo "$output" | jq -c '.validate_only_components')" >> $GITHUB_OUTPUT echo "benchmarks=$(echo "$output" | jq -r '.benchmarks')" >> $GITHUB_OUTPUT - name: Save components graph cache if: github.ref == 'refs/heads/dev' uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: .temp/components_graph.json key: components-graph-${{ hashFiles('esphome/components/**/*.py') }} integration-tests: name: Run integration tests (${{ matrix.bucket.name }}) runs-on: ubuntu-latest needs: - common - determine-jobs if: needs.determine-jobs.outputs.integration-tests == 'true' strategy: fail-fast: false matrix: bucket: ${{ fromJson(needs.determine-jobs.outputs.integration-test-buckets) }} steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Set up Python 3.13 id: python uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version: "3.13" - name: Restore Python virtual environment id: cache-venv uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: venv key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-venv-${{ needs.common.outputs.cache-key }} - name: Set up uv # Only needed on cache miss to populate the venv. if: steps.cache-venv.outputs.cache-hit != 'true' uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 with: enable-cache: true # Pin uv version so the action does not have to fetch the # manifest from raw.githubusercontent.com on every cache # miss; that fetch flakes on Windows runners. version: "0.11.15" - name: Create Python virtual environment if: steps.cache-venv.outputs.cache-hit != 'true' run: | python -m venv venv . venv/bin/activate python --version uv pip install -r requirements.txt -r requirements_test.txt uv pip install -e . - name: Register matcher run: echo "::add-matcher::.github/workflows/matchers/pytest.json" - name: Run integration tests env: # JSON array of test paths; parsed into a bash array below to avoid # shell word-splitting / glob hazards. BUCKET_TESTS: ${{ toJson(matrix.bucket.tests) }} run: | . venv/bin/activate mapfile -t test_files < <(echo "$BUCKET_TESTS" | jq -r '.[]') echo "Bucket ${{ matrix.bucket.name }}: running ${#test_files[@]} integration tests" pytest -vv --no-cov --tb=native --durations=30 -n auto "${test_files[@]}" cpp-unit-tests: name: Run C++ unit tests runs-on: ubuntu-24.04 needs: - common - determine-jobs if: github.event_name == 'pull_request' && (needs.determine-jobs.outputs.cpp-unit-tests-run-all == 'true' || needs.determine-jobs.outputs.cpp-unit-tests-components != '[]') steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Run cpp_unit_test.py run: | . venv/bin/activate if [ "${{ needs.determine-jobs.outputs.cpp-unit-tests-run-all }}" = "true" ]; then script/cpp_unit_test.py --all else ARGS=$(echo '${{ needs.determine-jobs.outputs.cpp-unit-tests-components }}' | jq -r '.[] | @sh' | xargs) script/cpp_unit_test.py $ARGS fi benchmarks: name: Run CodSpeed benchmarks runs-on: ubuntu-24.04 needs: - common - determine-jobs if: >- (github.event_name == 'push' && github.ref_name == 'dev') || (github.event_name == 'pull_request' && needs.determine-jobs.outputs.benchmarks == 'true') steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Build benchmarks id: build run: | . venv/bin/activate export BENCHMARK_LIB_CONFIG=$(python script/setup_codspeed_lib.py) # --build-only prints BUILD_BINARY= to stdout BINARY=$(script/cpp_benchmark.py --all --build-only | grep '^BUILD_BINARY=' | tail -1 | cut -d= -f2-) echo "binary=$BINARY" >> $GITHUB_OUTPUT - name: Run CodSpeed benchmarks uses: CodSpeedHQ/action@9d332c4d90b43981c3e55ae8e38e68709996240f # v4.17.0 with: run: | . venv/bin/activate ${{ steps.build.outputs.binary }} pytest tests/benchmarks/python/ --codspeed --no-cov mode: simulation clang-tidy-single: name: ${{ matrix.name }} runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.clang-tidy == 'true' env: GH_TOKEN: ${{ github.token }} # esp32-arduino-tidy installs ESP-IDF natively; share the native IDF cache. ESPHOME_ESP_IDF_PREFIX: ~/.esphome-idf strategy: fail-fast: false max-parallel: 2 matrix: include: - id: clang-tidy name: Run script/clang-tidy for ESP8266 options: --environment esp8266-arduino-tidy --grep USE_ESP8266 pio_cache_key: tidyesp8266 - id: clang-tidy name: Run script/clang-tidy for ESP32 Arduino options: --environment esp32-arduino-tidy --grep USE_ARDUINO cache_idf: true - id: clang-tidy name: Run script/clang-tidy for ZEPHYR options: --environment nrf52-tidy --grep USE_ZEPHYR --grep USE_NRF52 pio_cache_key: tidy-zephyr ignore_errors: false steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: # Need history for HEAD~1 to work for checking changed files fetch-depth: 2 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Cache platformio if: github.ref == 'refs/heads/dev' && matrix.pio_cache_key uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: ~/.platformio key: platformio-${{ matrix.pio_cache_key }}-${{ hashFiles('platformio.ini') }} - name: Cache platformio if: github.ref != 'refs/heads/dev' && matrix.pio_cache_key uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: ~/.platformio key: platformio-${{ matrix.pio_cache_key }}-${{ hashFiles('platformio.ini') }} - name: Cache ESP-IDF install # Shared with the IDF tidy + native-IDF build jobs (same install). if: matrix.cache_idf uses: ./.github/actions/cache-esp-idf with: framework: arduino - name: Register problem matchers run: | echo "::add-matcher::.github/workflows/matchers/gcc.json" echo "::add-matcher::.github/workflows/matchers/clang-tidy.json" - name: Check if full clang-tidy scan needed id: check_full_scan run: | . venv/bin/activate # determine-jobs.clang-tidy-full-scan is true when core C++ changed # OR the ci-run-all label forced --force-all. Independent of the # hash check, both must produce a full scan in the job itself. if [ "${{ needs.determine-jobs.outputs.clang-tidy-full-scan }}" = "true" ]; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=determine_jobs" >> $GITHUB_OUTPUT elif python script/clang_tidy_hash.py --check; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=hash_changed" >> $GITHUB_OUTPUT else echo "full_scan=false" >> $GITHUB_OUTPUT echo "reason=normal" >> $GITHUB_OUTPUT fi - name: Run clang-tidy run: | . venv/bin/activate if [ "${{ steps.check_full_scan.outputs.full_scan }}" = "true" ]; then echo "Running FULL clang-tidy scan (reason: ${{ steps.check_full_scan.outputs.reason }})" script/clang-tidy --all-headers --fix ${{ matrix.options }} ${{ matrix.ignore_errors && '|| true' || '' }} else echo "Running clang-tidy on changed files only" script/clang-tidy --all-headers --fix --changed ${{ matrix.options }} ${{ matrix.ignore_errors && '|| true' || '' }} fi env: # Also cache libdeps, store them in a ~/.platformio subfolder PLATFORMIO_LIBDEPS_DIR: ~/.platformio/libdeps - name: Suggested changes run: script/ci-suggest-changes ${{ matrix.ignore_errors && '|| true' || '' }} # yamllint disable-line rule:line-length if: always() clang-tidy-nosplit: name: Run script/clang-tidy for ESP32 IDF runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.clang-tidy-mode == 'nosplit' env: GH_TOKEN: ${{ github.token }} # esp32-idf-tidy installs ESP-IDF natively; share the native IDF cache. ESPHOME_ESP_IDF_PREFIX: ~/.esphome-idf steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: # Need history for HEAD~1 to work for checking changed files fetch-depth: 2 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Cache ESP-IDF install # Shared with the Arduino tidy + native-IDF build jobs (same install). uses: ./.github/actions/cache-esp-idf - name: Register problem matchers run: | echo "::add-matcher::.github/workflows/matchers/gcc.json" echo "::add-matcher::.github/workflows/matchers/clang-tidy.json" - name: Check if full clang-tidy scan needed id: check_full_scan run: | . venv/bin/activate # determine-jobs.clang-tidy-full-scan is true when core C++ changed # OR the ci-run-all label forced --force-all. Independent of the # hash check, both must produce a full scan in the job itself. if [ "${{ needs.determine-jobs.outputs.clang-tidy-full-scan }}" = "true" ]; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=determine_jobs" >> $GITHUB_OUTPUT elif python script/clang_tidy_hash.py --check; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=hash_changed" >> $GITHUB_OUTPUT else echo "full_scan=false" >> $GITHUB_OUTPUT echo "reason=normal" >> $GITHUB_OUTPUT fi - name: Run clang-tidy run: | . venv/bin/activate if [ "${{ steps.check_full_scan.outputs.full_scan }}" = "true" ]; then echo "Running FULL clang-tidy scan (reason: ${{ steps.check_full_scan.outputs.reason }})" script/clang-tidy --all-headers --fix --environment esp32-idf-tidy else echo "Running clang-tidy on changed files only" script/clang-tidy --all-headers --fix --changed --environment esp32-idf-tidy fi env: # Also cache libdeps, store them in a ~/.platformio subfolder PLATFORMIO_LIBDEPS_DIR: ~/.platformio/libdeps - name: Suggested changes run: script/ci-suggest-changes if: always() clang-tidy-split: name: ${{ matrix.name }} runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.clang-tidy-mode == 'split' env: GH_TOKEN: ${{ github.token }} # esp32-idf-tidy installs ESP-IDF natively; share the native IDF cache. ESPHOME_ESP_IDF_PREFIX: ~/.esphome-idf strategy: fail-fast: false max-parallel: 3 matrix: include: - id: clang-tidy name: Run script/clang-tidy for ESP32 IDF 1/3 options: --environment esp32-idf-tidy --split-num 3 --split-at 1 - id: clang-tidy name: Run script/clang-tidy for ESP32 IDF 2/3 options: --environment esp32-idf-tidy --split-num 3 --split-at 2 - id: clang-tidy name: Run script/clang-tidy for ESP32 IDF 3/3 options: --environment esp32-idf-tidy --split-num 3 --split-at 3 steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: # Need history for HEAD~1 to work for checking changed files fetch-depth: 2 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Cache ESP-IDF install # Shared with the Arduino tidy + native-IDF build jobs (same install). uses: ./.github/actions/cache-esp-idf - name: Register problem matchers run: | echo "::add-matcher::.github/workflows/matchers/gcc.json" echo "::add-matcher::.github/workflows/matchers/clang-tidy.json" - name: Check if full clang-tidy scan needed id: check_full_scan run: | . venv/bin/activate # determine-jobs.clang-tidy-full-scan is true when core C++ changed # OR the ci-run-all label forced --force-all. Independent of the # hash check, both must produce a full scan in the job itself. if [ "${{ needs.determine-jobs.outputs.clang-tidy-full-scan }}" = "true" ]; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=determine_jobs" >> $GITHUB_OUTPUT elif python script/clang_tidy_hash.py --check; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=hash_changed" >> $GITHUB_OUTPUT else echo "full_scan=false" >> $GITHUB_OUTPUT echo "reason=normal" >> $GITHUB_OUTPUT fi - name: Run clang-tidy run: | . venv/bin/activate if [ "${{ steps.check_full_scan.outputs.full_scan }}" = "true" ]; then echo "Running FULL clang-tidy scan (reason: ${{ steps.check_full_scan.outputs.reason }})" script/clang-tidy --all-headers --fix ${{ matrix.options }} else echo "Running clang-tidy on changed files only" script/clang-tidy --all-headers --fix --changed ${{ matrix.options }} fi env: # Also cache libdeps, store them in a ~/.platformio subfolder PLATFORMIO_LIBDEPS_DIR: ~/.platformio/libdeps - name: Suggested changes run: script/ci-suggest-changes if: always() clang-tidy-esp32-variants: name: ${{ matrix.name }} runs-on: ubuntu-24.04 needs: - common - determine-jobs if: needs.determine-jobs.outputs.clang-tidy == 'true' env: GH_TOKEN: ${{ github.token }} # The variant tidy envs install ESP-IDF natively; share the native IDF cache. ESPHOME_ESP_IDF_PREFIX: ~/.esphome-idf strategy: fail-fast: false max-parallel: 3 matrix: include: - id: clang-tidy name: Run script/clang-tidy for ESP32 S3 options: --environment esp32s3-idf-tidy --grep USE_ESP32_VARIANT_ESP32S3 - id: clang-tidy name: Run script/clang-tidy for ESP32 P4 # P4 has no native Wi-Fi/BLE; those run over the hosted co-processor, # so their code paths differ -- lint them under the P4 build too. # yamllint disable-line rule:line-length options: --environment esp32p4-idf-tidy --grep USE_ESP32_VARIANT_ESP32P4 --grep USE_ESP32_HOSTED --grep USE_WIFI --grep USE_BLE - id: clang-tidy name: Run script/clang-tidy for ESP32 C6 # yamllint disable-line rule:line-length options: --environment esp32c6-idf-tidy --grep USE_ESP32_VARIANT_ESP32C6 --grep USE_OPENTHREAD --grep USE_ZIGBEE steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: # Need history for HEAD~1 to work for checking changed files fetch-depth: 2 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Cache ESP-IDF install # Shared with the IDF/Arduino clang-tidy jobs + native-IDF build (same install). uses: ./.github/actions/cache-esp-idf - name: Register problem matchers run: | echo "::add-matcher::.github/workflows/matchers/gcc.json" echo "::add-matcher::.github/workflows/matchers/clang-tidy.json" - name: Check if full clang-tidy scan needed id: check_full_scan run: | . venv/bin/activate # determine-jobs.clang-tidy-full-scan is true when core C++ changed # OR the ci-run-all label forced --force-all. Independent of the # hash check, both must produce a full scan in the job itself. if [ "${{ needs.determine-jobs.outputs.clang-tidy-full-scan }}" = "true" ]; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=determine_jobs" >> $GITHUB_OUTPUT elif python script/clang_tidy_hash.py --check; then echo "full_scan=true" >> $GITHUB_OUTPUT echo "reason=hash_changed" >> $GITHUB_OUTPUT else echo "full_scan=false" >> $GITHUB_OUTPUT echo "reason=normal" >> $GITHUB_OUTPUT fi - name: Run clang-tidy # Limited variant scan: only the files carrying that variant's code paths # (no --all-headers; the comprehensive esp32-idf pass covers the shared tree). run: | . venv/bin/activate if [ "${{ steps.check_full_scan.outputs.full_scan }}" = "true" ]; then echo "Running FULL clang-tidy scan (reason: ${{ steps.check_full_scan.outputs.reason }})" script/clang-tidy --fix ${{ matrix.options }} else echo "Running clang-tidy on changed files only" script/clang-tidy --fix --changed ${{ matrix.options }} fi - name: Suggested changes run: script/ci-suggest-changes if: always() test-build-components-split: name: Test components batch (${{ matrix.components }}) runs-on: ubuntu-24.04 needs: - common - determine-jobs if: github.event_name == 'pull_request' && fromJSON(needs.determine-jobs.outputs.component-test-count) > 0 strategy: fail-fast: false max-parallel: ${{ (startsWith(github.base_ref, 'beta') || startsWith(github.base_ref, 'release')) && 8 || 4 }} matrix: components: ${{ fromJson(needs.determine-jobs.outputs.component-test-batches) }} steps: - name: Show disk space run: | echo "Available disk space:" df -h - name: List components run: echo ${{ matrix.components }} - name: Cache apt packages uses: awalsh128/cache-apt-pkgs-action@acb598e5ddbc6f68a970c5da0688d2f3a9f04d05 # v1.5.3 with: packages: libsdl2-dev version: 1.0 - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Validate and compile components with intelligent grouping run: | . venv/bin/activate # Check if /mnt has more free space than / before bind mounting # Extract available space in KB for comparison root_avail=$(df -k / | awk 'NR==2 {print $4}') mnt_avail=$(df -k /mnt 2>/dev/null | awk 'NR==2 {print $4}') echo "Available space: / has ${root_avail}KB, /mnt has ${mnt_avail}KB" # Only use /mnt if it has more space than / if [ -n "$mnt_avail" ] && [ "$mnt_avail" -gt "$root_avail" ]; then echo "Using /mnt for build files (more space available)" # Bind mount PlatformIO directory to /mnt (tools, packages, build cache all go there) sudo mkdir -p /mnt/platformio sudo chown $USER:$USER /mnt/platformio mkdir -p ~/.platformio sudo mount --bind /mnt/platformio ~/.platformio # Bind mount test build directory to /mnt sudo mkdir -p /mnt/test_build_components_build sudo chown $USER:$USER /mnt/test_build_components_build mkdir -p tests/test_build_components/build sudo mount --bind /mnt/test_build_components_build tests/test_build_components/build else echo "Using / for build files (more space available than /mnt or /mnt unavailable)" fi # Convert space-separated components to comma-separated for Python script components_csv=$(echo "${{ matrix.components }}" | tr ' ' ',') # Only isolate directly changed components when targeting dev branch # For beta/release branches, group everything for faster CI # # WHY ISOLATE DIRECTLY CHANGED COMPONENTS? # - Isolated tests run WITHOUT --testing-mode, enabling full validation # - This catches pin conflicts and other issues in directly changed code # - Grouped tests use --testing-mode to allow config merging (disables some checks) # - Dependencies are safe to group since they weren't modified in this PR if [[ "${{ github.base_ref }}" == beta* ]] || [[ "${{ github.base_ref }}" == release* ]]; then directly_changed_csv="" echo "Testing components: $components_csv" echo "Target branch: ${{ github.base_ref }} - grouping all components" else directly_changed_csv=$(echo '${{ needs.determine-jobs.outputs.directly-changed-components-with-tests }}' | jq -r 'join(",")') echo "Testing components: $components_csv" echo "Target branch: ${{ github.base_ref }} - isolating directly changed components: $directly_changed_csv" fi echo "" # Show disk space before validation echo "Disk space before config validation:" df -h echo "" # Run config validation with grouping and isolation python3 script/test_build_components.py -e config -c "$components_csv" -f --isolate "$directly_changed_csv" echo "" echo "Config validation passed! Starting compilation..." echo "" # Compute the compile-stage component list. Components whose only # changes are validate.*.yaml files are config-only -- their source # and test fixtures didn't move, so rebuilding firmware adds no # signal. Subtract them from this batch before invoking compile. validate_only_json='${{ needs.determine-jobs.outputs.validate-only-components }}' if [ -z "$validate_only_json" ]; then validate_only_json='[]' fi if ! validate_only_csv=$(echo "$validate_only_json" | jq -r 'join(",")'); then echo "::error::Failed to render validate-only-components as CSV from: $validate_only_json" exit 1 fi if [ -z "$validate_only_csv" ]; then compile_csv="$components_csv" else components_sorted=$(echo "$components_csv" | tr ',' '\n' | sort -u) validate_sorted=$(echo "$validate_only_csv" | tr ',' '\n' | sort -u) if ! diff_out=$(comm -23 <(echo "$components_sorted") <(echo "$validate_sorted")); then echo "::error::Failed to compute compile component subset." exit 1 fi compile_csv=$(echo "$diff_out" | paste -sd ',' -) skipped=$(comm -12 <(echo "$components_sorted") <(echo "$validate_sorted") | paste -sd ',' -) if [ -n "$skipped" ]; then echo "Validate-only components in this batch (skipping compile): $skipped" fi fi # Show disk space before compilation echo "Disk space before compilation:" df -h echo "" if [ -n "$compile_csv" ]; then # Run compilation with grouping and isolation python3 script/test_build_components.py -e compile -c "$compile_csv" -f --isolate "$directly_changed_csv" else echo "All components in this batch are validate-only -- skipping compile stage." fi test-native-idf: name: Test components with native ESP-IDF runs-on: ubuntu-24.04 needs: - common - determine-jobs if: github.event_name == 'pull_request' && needs.determine-jobs.outputs.native-idf == 'true' env: ESPHOME_ESP_IDF_PREFIX: ~/.esphome-idf # Comma-joined subset of the native-IDF representative component list, # computed by script/determine-jobs.py (native_idf_components_to_test). # Single source of truth -- the full list lives in # script/determine-jobs.py::NATIVE_IDF_TEST_COMPONENTS. TEST_COMPONENTS: ${{ needs.determine-jobs.outputs.native-idf-components }} steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Prepare build storage on /mnt # Bind-mount the larger /mnt disk over the IDF install + build dirs BEFORE # restoring the cache, so the ~4.5GB restore lands on the roomier volume # instead of being shadowed by a mount set up later in the run step. run: | root_avail=$(df -k / | awk 'NR==2 {print $4}') mnt_avail=$(df -k /mnt 2>/dev/null | awk 'NR==2 {print $4}') echo "Available space: / has ${root_avail}KB, /mnt has ${mnt_avail}KB" if [ -n "$mnt_avail" ] && [ "$mnt_avail" -gt "$root_avail" ]; then echo "Using /mnt for build files (more space available)" sudo mkdir -p /mnt/esphome-idf sudo chown $USER:$USER /mnt/esphome-idf mkdir -p ~/.esphome-idf sudo mount --bind /mnt/esphome-idf ~/.esphome-idf sudo mkdir -p /mnt/test_build_components_build sudo chown $USER:$USER /mnt/test_build_components_build mkdir -p tests/test_build_components/build sudo mount --bind /mnt/test_build_components_build tests/test_build_components/build else echo "Using / for build files (more space available than /mnt or /mnt unavailable)" fi - name: Cache ESP-IDF install # Shared with the IDF/Arduino clang-tidy jobs (same install); restores # into the /mnt bind-mount prepared above when present. uses: ./.github/actions/cache-esp-idf - name: Run native ESP-IDF compile test run: | . venv/bin/activate echo "Testing components: $TEST_COMPONENTS" echo "" # Show disk space before validation echo "Disk space before config validation:" df -h echo "" # Run config validation (auto-grouped by test_build_components.py) python3 script/test_build_components.py -e config -t esp32-idf -c "$TEST_COMPONENTS" -f --toolchain esp-idf echo "" echo "Config validation passed! Starting compilation..." echo "" # Show disk space before compilation echo "Disk space before compilation:" df -h echo "" # Run compilation (auto-grouped by test_build_components.py) python3 script/test_build_components.py -e compile -t esp32-idf -c "$TEST_COMPONENTS" -f --toolchain esp-idf - name: Save ESPHome cache if: github.ref == 'refs/heads/dev' uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: ~/.esphome-idf key: ${{ runner.os }}-esphome-${{ needs.common.outputs.cache-key }} pre-commit-ci-lite: name: pre-commit.ci lite runs-on: ubuntu-latest needs: - common - determine-jobs if: github.event_name == 'pull_request' && !startsWith(github.base_ref, 'beta') && !startsWith(github.base_ref, 'release') && needs.determine-jobs.outputs.core-ci == 'true' steps: - name: Check out code from GitHub uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - uses: esphome/pre-commit-action@43cd1109c09c544d97196f7730ee5b2e0cc6d81e # v3.0.1 fork with pinned actions/cache env: SKIP: pylint,clang-tidy-hash,ci-custom - uses: pre-commit-ci/lite-action@5d6cc0eb514c891a40562a58a8e71576c5c7fb43 # v1.1.0 if: always() memory-impact-target-branch: name: Build target branch for memory impact runs-on: ubuntu-24.04 needs: - common - determine-jobs if: github.event_name == 'pull_request' && fromJSON(needs.determine-jobs.outputs.memory_impact).should_run == 'true' outputs: ram_usage: ${{ steps.extract.outputs.ram_usage }} flash_usage: ${{ steps.extract.outputs.flash_usage }} cache_hit: ${{ steps.cache-memory-analysis.outputs.cache-hit }} skip: ${{ steps.check-script.outputs.skip || steps.check-tests.outputs.skip }} steps: - name: Check out target branch uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: ref: ${{ github.base_ref }} # Check if memory impact extraction script exists on target branch # If not, skip the analysis (this handles older branches that don't have the feature) - name: Check for memory impact script id: check-script run: | if [ -f "script/ci_memory_impact_extract.py" ]; then echo "skip=false" >> $GITHUB_OUTPUT else echo "skip=true" >> $GITHUB_OUTPUT echo "::warning::ci_memory_impact_extract.py not found on target branch, skipping memory impact analysis" fi # Check if test files exist on the target branch for the requested # components and platform. When a PR adds new test files for a platform, # the target branch won't have them yet, so skip instead of failing. # This check must be done here (not in determine-jobs.py) because # determine-jobs runs on the PR branch and cannot see what the target # branch has. - name: Check for test files on target branch id: check-tests if: steps.check-script.outputs.skip != 'true' run: | components='${{ toJSON(fromJSON(needs.determine-jobs.outputs.memory_impact).components) }}' platform="${{ fromJSON(needs.determine-jobs.outputs.memory_impact).platform }}" found=false for component in $(echo "$components" | jq -r '.[]'); do # Check for test files matching the platform (test.platform.yaml or test-*.platform.yaml) for f in tests/components/${component}/test*.${platform}.yaml; do if [ -f "$f" ]; then found=true break 2 fi done done if [ "$found" = false ]; then echo "skip=true" >> $GITHUB_OUTPUT echo "::warning::No test files found on target branch for platform ${platform}, skipping memory impact analysis" else echo "skip=false" >> $GITHUB_OUTPUT fi # All remaining steps only run if script and tests exist - name: Generate cache key id: cache-key if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' run: | # Get the commit SHA of the target branch target_sha=$(git rev-parse HEAD) # Hash the build infrastructure files (all files that affect build/analysis) infra_hash=$(cat \ script/test_build_components.py \ script/ci_memory_impact_extract.py \ script/analyze_component_buses.py \ script/merge_component_configs.py \ script/ci_helpers.py \ .github/workflows/ci.yml \ | sha256sum | cut -d' ' -f1) # Get platform and components from job inputs platform="${{ fromJSON(needs.determine-jobs.outputs.memory_impact).platform }}" components='${{ toJSON(fromJSON(needs.determine-jobs.outputs.memory_impact).components) }}' components_hash=$(echo "$components" | sha256sum | cut -d' ' -f1) # Combine into cache key cache_key="memory-analysis-target-${target_sha}-${infra_hash}-${platform}-${components_hash}" echo "cache-key=${cache_key}" >> $GITHUB_OUTPUT echo "Cache key: ${cache_key}" - name: Restore cached memory analysis id: cache-memory-analysis if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: memory-analysis-target.json key: ${{ steps.cache-key.outputs.cache-key }} - name: Cache status if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' run: | if [ "${{ steps.cache-memory-analysis.outputs.cache-hit }}" == "true" ]; then echo "✓ Cache hit! Using cached memory analysis results." echo " Skipping build step to save time." else echo "✗ Cache miss. Will build and analyze memory usage." fi - name: Restore Python if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' && steps.cache-memory-analysis.outputs.cache-hit != 'true' uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Cache platformio if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' && steps.cache-memory-analysis.outputs.cache-hit != 'true' uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: ~/.platformio key: platformio-memory-${{ fromJSON(needs.determine-jobs.outputs.memory_impact).platform }}-${{ hashFiles('platformio.ini') }} - name: Build, compile, and analyze memory if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' && steps.cache-memory-analysis.outputs.cache-hit != 'true' id: build run: | . venv/bin/activate components='${{ toJSON(fromJSON(needs.determine-jobs.outputs.memory_impact).components) }}' platform="${{ fromJSON(needs.determine-jobs.outputs.memory_impact).platform }}" echo "Building with test_build_components.py for $platform with components:" echo "$components" | jq -r '.[]' | sed 's/^/ - /' # Use test_build_components.py which handles grouping automatically # Pass components as comma-separated list component_list=$(echo "$components" | jq -r 'join(",")') echo "Compiling with test_build_components.py..." # Run build and extract memory with auto-detection of build directory for detailed analysis # Use tee to show output in CI while also piping to extraction script python script/test_build_components.py \ -e compile \ -c "$component_list" \ -t "$platform" \ --base-only 2>&1 | \ tee /dev/stderr | \ python script/ci_memory_impact_extract.py \ --output-env \ --output-json memory-analysis-target.json # Add metadata to JSON before caching python script/ci_add_metadata_to_json.py \ --json-file memory-analysis-target.json \ --components "$components" \ --platform "$platform" - name: Save memory analysis to cache if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' && steps.cache-memory-analysis.outputs.cache-hit != 'true' && steps.build.outcome == 'success' uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: memory-analysis-target.json key: ${{ steps.cache-key.outputs.cache-key }} - name: Extract memory usage for outputs id: extract if: steps.check-script.outputs.skip != 'true' && steps.check-tests.outputs.skip != 'true' run: | if [ -f memory-analysis-target.json ]; then ram=$(jq -r '.ram_bytes' memory-analysis-target.json) flash=$(jq -r '.flash_bytes' memory-analysis-target.json) echo "ram_usage=${ram}" >> $GITHUB_OUTPUT echo "flash_usage=${flash}" >> $GITHUB_OUTPUT echo "RAM: ${ram} bytes, Flash: ${flash} bytes" else echo "Error: memory-analysis-target.json not found" exit 1 fi - name: Upload memory analysis JSON uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: memory-analysis-target path: memory-analysis-target.json if-no-files-found: warn retention-days: 1 memory-impact-pr-branch: name: Build PR branch for memory impact runs-on: ubuntu-24.04 needs: - common - determine-jobs if: github.event_name == 'pull_request' && fromJSON(needs.determine-jobs.outputs.memory_impact).should_run == 'true' outputs: ram_usage: ${{ steps.extract.outputs.ram_usage }} flash_usage: ${{ steps.extract.outputs.flash_usage }} steps: - name: Check out PR branch uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Cache platformio uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 with: path: ~/.platformio key: platformio-memory-${{ fromJSON(needs.determine-jobs.outputs.memory_impact).platform }}-${{ hashFiles('platformio.ini') }} - name: Build, compile, and analyze memory id: extract run: | . venv/bin/activate components='${{ toJSON(fromJSON(needs.determine-jobs.outputs.memory_impact).components) }}' platform="${{ fromJSON(needs.determine-jobs.outputs.memory_impact).platform }}" echo "Building with test_build_components.py for $platform with components:" echo "$components" | jq -r '.[]' | sed 's/^/ - /' # Use test_build_components.py which handles grouping automatically # Pass components as comma-separated list component_list=$(echo "$components" | jq -r 'join(",")') echo "Compiling with test_build_components.py..." # Run build and extract memory with auto-detection of build directory for detailed analysis # Use tee to show output in CI while also piping to extraction script python script/test_build_components.py \ -e compile \ -c "$component_list" \ -t "$platform" \ --base-only 2>&1 | \ tee /dev/stderr | \ python script/ci_memory_impact_extract.py \ --output-env \ --output-json memory-analysis-pr.json # Add metadata to JSON (components and platform are in shell variables above) python script/ci_add_metadata_to_json.py \ --json-file memory-analysis-pr.json \ --components "$components" \ --platform "$platform" - name: Upload memory analysis JSON uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: memory-analysis-pr path: memory-analysis-pr.json if-no-files-found: warn retention-days: 1 memory-impact-comment: name: Comment memory impact runs-on: ubuntu-24.04 needs: - common - determine-jobs - memory-impact-target-branch - memory-impact-pr-branch if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && fromJSON(needs.determine-jobs.outputs.memory_impact).should_run == 'true' && needs.memory-impact-target-branch.outputs.skip != 'true' permissions: contents: read # actions/checkout to load the comment-posting script pull-requests: write # ci_memory_impact_comment.py posts/updates the memory-impact comment on the PR env: GH_TOKEN: ${{ github.token }} steps: - name: Check out code uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Restore Python uses: ./.github/actions/restore-python with: python-version: ${{ env.DEFAULT_PYTHON }} cache-key: ${{ needs.common.outputs.cache-key }} - name: Download target analysis JSON uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: memory-analysis-target path: ./memory-analysis continue-on-error: true - name: Download PR analysis JSON uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: memory-analysis-pr path: ./memory-analysis continue-on-error: true - name: Post or update PR comment env: PR_NUMBER: ${{ github.event.pull_request.number }} run: | . venv/bin/activate # Pass JSON file paths directly to Python script # All data is extracted from JSON files for security python script/ci_memory_impact_comment.py \ --pr-number "$PR_NUMBER" \ --target-json ./memory-analysis/memory-analysis-target.json \ --pr-json ./memory-analysis/memory-analysis-pr.json ci-status: name: CI Status runs-on: ubuntu-24.04 needs: - common - ci-custom - pylint - pytest - integration-tests - clang-tidy-single - clang-tidy-nosplit - clang-tidy-split - clang-tidy-esp32-variants - determine-jobs - device-builder - test-build-components-split - test-native-idf - pre-commit-ci-lite - memory-impact-target-branch - memory-impact-pr-branch - memory-impact-comment if: always() steps: - name: Check job results env: NEEDS_JSON: ${{ toJSON(needs) }} run: | # memory-impact-target-branch is allowed to fail without blocking CI. # This job builds the target branch (dev/beta/release) which may fail because: # 1. The target branch has a build issue independent of this PR # 2. This PR fixes a build issue on the target branch # In either case, we only care that the PR branch builds successfully. echo "$NEEDS_JSON" | jq -e 'del(.["memory-impact-target-branch"]) | all(.result != "failure")'