ci.yaml

name: CI
on:
  push:
    paths:
      - .github/workflows/ci.yaml
      - "firmware/**"
  pull_request:
    paths:
      - .github/workflows/ci.yaml
      - "firmware/**"
  workflow_dispatch:

env:
  CARGO_TERM_COLOR: always

jobs:
  check:
    name: Check
    runs-on: ubuntu-latest
    steps:
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: riscv32imc-unknown-none-elf
          components: clippy, rustfmt
      - name: Check out repository
        uses: actions/checkout@v4
      - name: Cache cargo data
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/git
            ~/.cargo/registry
          # intentionally not caching `target` here yet
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
      - name: Check formatting
        run: cargo fmt --all --check
        working-directory: firmware
      - name: Clippy
        run: cargo clippy --workspace --all-targets -- --deny warnings --allow deprecated
        working-directory: firmware

  build:
    name: Build
    needs: [check]
    runs-on: ubuntu-latest
    steps:
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: riscv32imc-unknown-none-elf
      - name: Check out repository
        uses: actions/checkout@v4
      - name: Cache cargo data
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/git
            ~/.cargo/registry
          # intentionally not caching `target` here yet
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
      - name: Build everything
        run: cargo build --workspace --all-targets --release
        working-directory: firmware
      - name: Upload build artifact
        uses: actions/upload-artifact@v4
        with:
          name: touch-n-drink-elf
          path: |
            firmware/target/riscv32imc-unknown-none-elf/release/touch-n-drink
          if-no-files-found: error

  image:
    name: Image
    needs: [build]
    runs-on: ubuntu-latest
    steps:
      - name: Cache espflash
        id: cache-espflash
        uses: actions/cache@v4
        with:
          path: ~/.cargo/bin/espflash
          key: ${{ runner.os }}-espflash
      - name: Install dependencies
        if: steps.cache-espflash.outputs.cache-hit != 'true'
        run: sudo apt-get update && sudo apt-get install pkg-config libudev-dev
      - name: Install espflash
        if: steps.cache-espflash.outputs.cache-hit != 'true'
        run: cargo install espflash
      - name: Download build artifact
        uses: actions/download-artifact@v4
        with:
          name: touch-n-drink-elf
      - name: Generate ESP32 image
        run: espflash save-image --chip esp32c3 --merge --skip-padding touch-n-drink touch-n-drink-esp32c3.bin
      - name: Generate SHA-256 checksum
        run: shasum -a 256 touch-n-drink-esp32c3.bin >touch-n-drink-esp32c3.sha256
      - name: Upload image artifact
        uses: actions/upload-artifact@v4
        with:
          name: touch-n-drink-esp32c3
          path: |
            touch-n-drink-esp32c3*
          if-no-files-found: error

  release:
    name: Release
    permissions:
      contents: write
    needs: [image]
    if: github.repository == 'zargony/touch-n-drink' && startsWith(github.ref, 'refs/tags/firmware-')
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v4
        with:
          sparse-checkout: |
            firmware/CHANGELOG.md
      - name: Download image artifact
        uses: actions/download-artifact@v4
        with:
          name: touch-n-drink-esp32c3
      - name: Release
        uses: softprops/action-gh-release@v2
        with:
          body_path: firmware/CHANGELOG.md
          draft: true
          files: |
            touch-n-drink*
          fail_on_unmatched_files: true