name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
inputs:
generate_docs:
description: 'Generate API documentation'
type: boolean
default: false
env:
CARGO_TERM_COLOR: always
RUSTFLAGS: -D warnings
jobs:
test:
name: Test
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- name: Cache cargo
uses: Swatinem/rust-cache@v2
- name: Print Rust version
run: |
rustc --version
cargo --version
- name: Check formatting
run: cargo fmt --check
- name: Run clippy lints
run: cargo clippy --tests -- -D warnings
- name: Run tests
run: cargo test
build:
name: Build
runs-on: windows-latest
needs: test
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cache cargo
uses: Swatinem/rust-cache@v2
- name: Compile release build
run: cargo build --release
- name: Generate API documentation
if: ${{ inputs.generate_docs }}
run: cargo doc --no-deps
- name: Copy docs to docs/doc
if: ${{ inputs.generate_docs }}
shell: pwsh
run: |
if (Test-Path 'docs\doc') { Remove-Item -Recurse -Force 'docs\doc' }
Copy-Item -Recurse 'target\doc' 'docs\doc'
- name: Upload release binary
uses: actions/upload-artifact@v4
with:
name: panoptico-windows
path: target/release/panoptico.exe
if-no-files-found: error
- name: Upload API documentation
if: ${{ inputs.generate_docs }}
uses: actions/upload-artifact@v4
with:
name: api-documentation
path: docs/doc
if-no-files-found: error