esp-hal/.github/workflows/ci.yml

# NOTE:
#
# When adding support for a new chip to `esp-hal`, there are a number of
# updates which must be made to the CI workflow in order to reflect this; the
# changes are:
#
# 1.) In the 'esp-hal' job, add the appropriate build and semver-check command.
# 1a.) If the device has a low-power core (which is supported in
#      `esp-lp-hal`), then update the `if` condition to build prerequisites.
# 2.) In the 'msrv' job, add checks as needed for the new chip.

name: CI

on:
  pull_request:
    types: [opened, synchronize, reopened]
  push:
    branches-ignore:
      - "gh-readonly-queue/**"
      - "main"
  merge_group:
  workflow_dispatch:

env:
  CARGO_TERM_COLOR: always
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  MSRV: "1.88.0"
  DEFMT_LOG: trace

# Cancel any currently running workflows from the same PR, branch, or
# tag when a new workflow is triggered.
#
# https://stackoverflow.com/a/66336834
concurrency:
  cancel-in-progress: true
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

jobs:
  # --------------------------------------------------------------------------
  # Build Packages

  esp-hal:
    runs-on: macos-m1-self-hosted
    env:
      CARGO_TARGET_DIR: ${{ github.workspace }}/target
      CI: 1
      SSID: SSID
      PASSWORD: PASSWORD
      STATIC_IP: 1.1.1.1
      GATEWAY_IP: 1.1.1.1
      HOST_IP: 1.1.1.1

    steps:
      - uses: actions/checkout@v4

      # Install the Rust toolchain for Xtensa devices:
      - uses: esp-rs/xtensa-toolchain@v1.6
        with:
          version: 1.89.0.0

      # Install the Rust stable toolchain for RISC-V devices:
      - uses: dtolnay/rust-toolchain@v1
        with:
          target: riscv32imc-unknown-none-elf,riscv32imac-unknown-none-elf
          toolchain: stable
          components: rust-src

      - name: Setup cargo-batch
        run: |
          if ! command -v cargo-batch &> /dev/null; then
              cargo install --git https://github.com/embassy-rs/cargo-batch cargo --bin cargo-batch --locked --force
          fi

      - name: Build and Check
        shell: bash
        run: |
          # lints and docs are checked separately
          cargo xcheck ci esp32 --toolchain esp --no-lint --no-docs
          cargo xcheck ci esp32s2 --toolchain esp --no-lint --no-docs
          cargo xcheck ci esp32s3 --toolchain esp --no-lint --no-docs
          cargo xcheck ci esp32c2 --toolchain stable --no-lint --no-docs
          cargo xcheck ci esp32c3 --toolchain stable --no-lint --no-docs
          cargo xcheck ci esp32c6 --toolchain stable --no-lint --no-docs
          cargo xcheck ci esp32h2 --toolchain stable --no-lint --no-docs

      - name: Semver-Check
        shell: bash
        # always invokes +esp internally
        run: |
          cargo xcheck semver-check --chips esp32 check
          cargo xcheck semver-check --chips esp32s2 check
          cargo xcheck semver-check --chips esp32s3 check
          cargo xcheck semver-check --chips esp32c2 check
          cargo xcheck semver-check --chips esp32c3 check
          cargo xcheck semver-check --chips esp32c6 check
          cargo xcheck semver-check --chips esp32h2 check

  detect-extras-runner:
    uses: ./.github/workflows/check_runner.yml
    with:
      primary-runner: macos-m1-self-hosted
      fallback-runner: ubuntu-latest

  extras:
    needs: detect-extras-runner
    runs-on: ${{ needs.detect-extras-runner.outputs.selected-runner }}
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: stable

      # Install dependencies for building the extra crates on ubuntu
      - name: Install dependencies
        if: runner.os == 'Linux'
        run: sudo apt-get update && sudo apt-get -y install musl-tools libudev-dev pkg-config
      # Build the extra crates
      - name: Build the bench-server
        run: cd extras/bench-server && cargo build
      - name: Build esp-wifishark
        run: cd extras/esp-wifishark && cargo build
      - name: Build ieee802154-sniffer
        run: cd extras/ieee802154-sniffer && cargo build

  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # Install the Rust toolchain for Xtensa devices:
      - uses: esp-rs/xtensa-toolchain@v1.6
        with:
          version: 1.88.0.0

      # Install the Rust stable toolchain for RISC-V devices:
      - uses: dtolnay/rust-toolchain@v1
        with:
          target: riscv32imc-unknown-none-elf,riscv32imac-unknown-none-elf
          toolchain: stable
          components: rust-src
      # Install the Rust nightly toolchain for RISC-V devices:
      - uses: dtolnay/rust-toolchain@v1
        with:
          target: riscv32imc-unknown-none-elf,riscv32imac-unknown-none-elf
          toolchain: nightly
          components: rust-src

      - name: Build docs
        shell: bash
        run: |
          cargo xtask build documentation

  # --------------------------------------------------------------------------
  # MSRV

  msrv:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: esp-rs/xtensa-toolchain@v1.6
        with:
          version: ${{ env.MSRV }}
      - uses: dtolnay/rust-toolchain@v1
        with:
          target: riscv32imc-unknown-none-elf,riscv32imac-unknown-none-elf,x86_64-unknown-linux-gnu
          toolchain: ${{ env.MSRV }}
          components: rust-src,clippy

      - name: Stable toolchain checks
        run: rustc +${{ env.MSRV }} --version --verbose
      - name: esp toolchain checks
        run: rustc +esp --version --verbose

      # Verify the MSRV for all chips by running a lint session
      - name: msrv RISCV (esp-hal)
        run: |
          cargo xtask lint-packages --chips esp32c2,esp32c3,esp32c6,esp32h2 --toolchain ${{ env.MSRV }}
      - name: msrv Xtensa (esp-hal)
        run: |
          cargo xtask lint-packages --chips esp32,esp32s2,esp32s3 --toolchain esp

  # --------------------------------------------------------------------------
  # host tests

  detect-host-tests-runner:
    uses: ./.github/workflows/check_runner.yml
    with:
      primary-runner: macos-m1-self-hosted
      fallback-runner: ubuntu-latest

  host-tests:
    needs: detect-host-tests-runner
    runs-on: ${{ needs.detect-host-tests-runner.outputs.selected-runner }}
    steps:
      - uses: actions/checkout@v4
      # Some of the configuration items in 'rustfmt.toml' require the 'nightly'
      # release channel, MIRI is only available in nightly
      - uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: nightly
          components: rustfmt,miri

      # Run xtask tests
      - name: Run xtask tests
        run: cd xtask && cargo test --features release

      # Check the formatting of all packages:
      - run: cargo xtask fmt-packages --check

      # Check metadata generation for all packages:
      - run: cargo xtask update-metadata --check

      # Run host tests for all applicable packages:
      - run: cargo xtask host-tests

  # --------------------------------------------------------------------------
  # Check links in .rs, .md, and .toml files

  link-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: lycheeverse/lychee-action@v2
        with:
          args: |
            --verbose
            --no-progress
            --format detailed
            --timeout 7
            --max-concurrency 6
            --accept "200,301,302"
            --exclude-path ".*/target/.*|.*/static\.files/.*|.*/docs/.*"
            './**/*.rs'
            './**/*.md'
            './**/*.toml'