Add MD documentation #273
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| push: | |
| workflow_dispatch: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # Examples: | |
| SSID: "" | |
| PASSWORD: "" | |
| STATIC_IP: "" | |
| GATEWAY_IP: "" | |
| # 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: | |
| esp32: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: esp-rs/[email protected] | |
| with: | |
| default: true | |
| buildtargets: esp32 | |
| ldproxy: false | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: build (ble) | |
| run: cd examples-esp32 && cargo build --release --example=ble --features=ble | |
| - name: build (async-ble) | |
| run: cd examples-esp32 && cargo build --release --example=async_ble --features=async,ble | |
| - name: build (dhcp) | |
| run: cd examples-esp32 && cargo build --release --example=dhcp --features=wifi | |
| - name: build (static_ip) | |
| run: cd examples-esp32 && cargo build --release --example=static_ip --features=wifi | |
| - name: build (esp_now) | |
| run: cd examples-esp32 && cargo build --release --example=esp_now --features=esp-now | |
| - name: build (embassy_esp_now) | |
| run: cd examples-esp32 && cargo build --release --example=embassy_esp_now --features=async,esp-now | |
| - name: build (embassy_dhcp) | |
| run: cd examples-esp32 && cargo build --release --example=embassy_dhcp --features=async,wifi,embassy-net | |
| - name: build (embassy_access_point) | |
| run: cd examples-esp32 && cargo build --release --example=embassy_access_point --features=async,wifi,embassy-net | |
| - name: build (static_ip) | |
| run: cd examples-esp32 && cargo build --release --example=static_ip --features=wifi | |
| esp32c2: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| target: riscv32imc-unknown-none-elf | |
| toolchain: nightly-2023-05-16 | |
| components: rust-src | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: build (ble) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=ble --features=ble | |
| - name: build (async-ble) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=async_ble --features=async,ble | |
| - name: build (dhcp) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=dhcp --features=wifi | |
| - name: build (static_ip) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=static_ip --features=wifi | |
| - name: build (esp_now) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=esp_now --features=esp-now | |
| - name: build (embassy_esp_now) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=embassy_esp_now --features=async,esp-now | |
| - name: build (embassy_dhcp) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=embassy_dhcp --features=async,wifi,embassy-net | |
| - name: build (embassy_access_point) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=embassy_access_point --features=async,wifi,embassy-net | |
| - name: build (static_ip) | |
| run: cd examples-esp32c2 && cargo +nightly-2023-05-16 build --release --example=static_ip --features=wifi | |
| esp32c3: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| target: riscv32imc-unknown-none-elf | |
| toolchain: nightly-2023-05-16 | |
| components: rust-src | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: build (ble) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=ble --features=ble | |
| - name: build (async-ble) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=async_ble --features=async,ble | |
| - name: build (coex) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=coex --features=wifi,ble | |
| - name: build (dhcp) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=dhcp --features=wifi | |
| - name: build (static_ip) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=static_ip --features=wifi | |
| - name: build (esp_now) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=esp_now --features=esp-now | |
| - name: build (embassy_esp_now) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=embassy_esp_now --features=async,esp-now | |
| - name: build (embassy_dhcp) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=embassy_dhcp --features=async,wifi,embassy-net | |
| - name: build (embassy_access_point) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=embassy_access_point --features=async,wifi,embassy-net | |
| - name: build (static_ip) | |
| run: cd examples-esp32c3 && cargo +nightly-2023-05-16 build --release --example=static_ip --features=wifi | |
| esp32c6: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| target: riscv32imac-unknown-none-elf | |
| toolchain: nightly-2023-05-16 | |
| components: rust-src | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: build (dhcp) | |
| run: cd examples-esp32c6 && cargo +nightly-2023-05-16 build --release --example=dhcp --features=wifi | |
| - name: build (static_ip) | |
| run: cd examples-esp32c6 && cargo +nightly-2023-05-16 build --release --example=static_ip --features=wifi | |
| - name: build (esp_now) | |
| run: cd examples-esp32c6 && cargo +nightly-2023-05-16 build --release --example=esp_now --features=esp-now | |
| - name: build (embassy_esp_now) | |
| run: cd examples-esp32c6 && cargo +nightly-2023-05-16 build --release --example=embassy_esp_now --features=async,esp-now | |
| - name: build (embassy_dhcp) | |
| run: cd examples-esp32c6 && cargo +nightly-2023-05-16 build --release --example=embassy_dhcp --features=async,wifi,embassy-net | |
| - name: build (embassy_access_point) | |
| run: cd examples-esp32c6 && cargo +nightly-2023-05-16 build --release --example=embassy_access_point --features=async,wifi,embassy-net | |
| - name: build (static_ip) | |
| run: cd examples-esp32c6 && cargo +nightly-2023-05-16 build --release --example=static_ip --features=wifi | |
| esp32s2: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: esp-rs/[email protected] | |
| with: | |
| default: true | |
| buildtargets: esp32s2 | |
| ldproxy: false | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: build (dhcp) | |
| run: cd examples-esp32s2 && cargo build --release --example=dhcp --features=wifi | |
| - name: build (static_ip) | |
| run: cd examples-esp32s2 && cargo build --release --example=static_ip --features=wifi | |
| - name: build (esp_now) | |
| run: cd examples-esp32s2 && cargo build --release --example=esp_now --features=esp-now | |
| - name: build (embassy_esp_now) | |
| run: cd examples-esp32s2 && cargo build --release --example=embassy_esp_now --features=async,esp-now | |
| - name: build (embassy_dhcp) | |
| run: cd examples-esp32s2 && cargo build --release --example=embassy_dhcp --features=async,wifi,embassy-net | |
| - name: build (embassy_access_point) | |
| run: cd examples-esp32s2 && cargo build --release --example=embassy_access_point --features=async,wifi,embassy-net | |
| - name: build (static_ip) | |
| run: cd examples-esp32s2 && cargo build --release --example=static_ip --features=wifi | |
| esp32s3: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: esp-rs/[email protected] | |
| with: | |
| default: true | |
| buildtargets: esp32s3 | |
| ldproxy: false | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: build (ble) | |
| run: cd examples-esp32s3 && cargo build --release --example=ble --features=ble | |
| - name: build (async-ble) | |
| run: cd examples-esp32s3 && cargo build --release --example=async_ble --features=async,ble | |
| - name: build (coex) | |
| run: cd examples-esp32s3 && cargo build --release --example=coex --features=wifi,ble | |
| - name: build (dhcp) | |
| run: cd examples-esp32s3 && cargo build --release --example=dhcp --features=wifi | |
| - name: build (static_ip) | |
| run: cd examples-esp32s3 && cargo build --release --example=static_ip --features=wifi | |
| - name: build (esp_now) | |
| run: cd examples-esp32s3 && cargo build --release --example=esp_now --features=esp-now | |
| - name: build (embassy_esp_now) | |
| run: cd examples-esp32s3 && cargo build --release --example=embassy_esp_now --features=async,esp-now | |
| - name: build (embassy_dhcp) | |
| run: cd examples-esp32s3 && cargo build --release --example=embassy_dhcp --features=async,wifi,embassy-net | |
| - name: build (embassy_access_point) | |
| run: cd examples-esp32s3 && cargo build --release --example=embassy_access_point --features=async,wifi,embassy-net | |
| - name: build (static_ip) | |
| run: cd examples-esp32s3 && cargo build --release --example=static_ip --features=wifi |