ci.yml

name: CI
on:
  push:

jobs:
  build-freebsd:
    permissions:
      contents: read
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
    - name: Build
      id: test
      uses: vmactions/freebsd-vm@v1
      with:
        release: "15.0"
        arch: x86_64
        usesh: true
        mem: 8192
        sync: rsync
        prepare: |
          pkg install -y rust hidapi pkgconf
        run: |
          cargo build -p framework_lib
          cargo build -p framework_tool

  build:
    name: Build Linux
    runs-on: ubuntu-24.04
    env:
      CARGO_NET_GIT_FETCH_WITH_CLI: true
    steps:
    - uses: actions/checkout@v4

    - name: Install dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y libudev-dev

    - name: Setup Rust toolchain
      run: rustup show

    - name: Build library (Linux)
      run: cargo build -p framework_lib

    - name: Build Linux tool
      run: cargo build -p framework_tool

    - name: Check if Linux tool can start
      run: cargo run -- --help

    - name: Upload Linux App
      uses: actions/upload-artifact@v4
      with:
        name: framework_tool_debug
        path: target/debug/framework_tool

    - name: Build Linux tool (Release)
      run: cargo build -p framework_tool --release --features nvidia

    - name: Upload Linux App
      uses: actions/upload-artifact@v4
      with:
        name: framework_tool
        path: target/release/framework_tool

    - name: Make sure nothing changed (e.g. Cargo.lock)
      run: git diff --exit-code

  build-uefi:
    name: Build UEFI
    runs-on: ubuntu-24.04
    env:
      CARGO_NET_GIT_FETCH_WITH_CLI: true
    steps:
    - uses: actions/checkout@v4

    - name: Setup Rust toolchain
      run: rustup show

    - name: Build UEFI application (no ESP)
      run: |
        make -C framework_uefi build/x86_64-unknown-uefi/boot.efi
        mv framework_uefi/build/x86_64-unknown-uefi/boot.efi framework_tool_full.efi
        make -C framework_uefi FEATURES=readonly build/x86_64-unknown-uefi/boot.efi
        cp framework_uefi/build/x86_64-unknown-uefi/boot.efi framework_tool.efi

    - name: Upload UEFI App
      uses: actions/upload-artifact@v4
      with:
        name: framework_efi.zip
        path: ./*.efi

    - name: Install mtools to build ESP and ISO (Linux)
      run: sudo apt-get install -y mtools genisoimage

    - name: Build ESP (Linux)
      run: make -C framework_uefi

    - name: Build ISO (Linux)
      run: make -C framework_uefi iso

    - name: Upload UEFI App ISO
      uses: actions/upload-artifact@v4
      with:
        name: UEFI-Shell-fwk.iso
        path: framework_uefi/build/x86_64-unknown-uefi/UEFI-Shell-fwk.iso

  build-windows:
    name: Build Windows
    runs-on: windows-2022
    env:
      CARGO_NET_GIT_FETCH_WITH_CLI: true
    steps:
    - uses: actions/checkout@v4

    - name: Setup Rust toolchain
      run: rustup show

    # Build debug library first to fail fast
    - name: Build library (Windows)
      run: cargo build -p framework_lib

    - name: Build Windows tool
      run: |
        cargo build -p framework_tool
        cargo build -p framework_tool --release --features nvidia

    - name: Check if Windows tool can start
      run: cargo run -- --help --release

    # Upload release build so that vcruntime is statically linked
    - name: Upload Windows App
      uses: actions/upload-artifact@v4
      with:
        name: framework_tool.exe
        path: target/release/framework_tool.exe


  test:
    name: Test Suite
    runs-on: ubuntu-latest
    env:
      CARGO_NET_GIT_FETCH_WITH_CLI: true
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y libudev-dev

      - name: Setup Rust toolchain
        run: rustup show

      - name: Run cargo test
        run: cargo test -p framework_lib

  lints:
    name: Lints
    runs-on: ubuntu-24.04
    env:
      CARGO_NET_GIT_FETCH_WITH_CLI: true
    steps:
    - uses: actions/checkout@v4

    - name: Install dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y libudev-dev

    - name: Setup Rust toolchain
      run: rustup show

    - name: Run cargo fmt
      run: cargo fmt --all -- --check

    - name: Run cargo clippy
      run: cargo clippy -p framework_lib -p framework_tool -- -D warnings

    - name: Check shell completions are up to date
      run: |
        cargo build -p framework_tool
        ./target/debug/framework_tool --generate-completions bash > /tmp/bash_completions
        ./target/debug/framework_tool --generate-completions zsh > /tmp/zsh_completions
        ./target/debug/framework_tool --generate-completions fish > /tmp/fish_completions
        diff completions/bash/framework_tool /tmp/bash_completions || { echo "Shell completions are out of date. See completions/README.md for regeneration instructions."; exit 1; }
        diff completions/zsh/_framework_tool /tmp/zsh_completions || { echo "Shell completions are out of date. See completions/README.md for regeneration instructions."; exit 1; }
        diff completions/fish/framework_tool.fish /tmp/fish_completions || { echo "Shell completions are out of date. See completions/README.md for regeneration instructions."; exit 1; }

  # Just make sure doc generation works
  doc:
    name: Generate docs
    runs-on: ubuntu-24.04
    env:
      CARGO_NET_GIT_FETCH_WITH_CLI: true
      # Fail if warnings are produced
      RUSTDOCFLAGS: -Dwarnings
    steps:
    - uses: actions/checkout@v4

    - name: Install dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y libudev-dev

    - name: Setup Rust toolchain
      run: rustup show

    - name: Run cargo doc
      run: cargo doc