name: CI
on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main ]
env:
CARGO_TERM_COLOR: always
jobs:
test:
name: Test Suite
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
rust: [stable]
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
toolchain: ${{ matrix.rust }}
components: clippy, rustfmt
- name: Cache cargo dependencies
uses: actions/cache@v3
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-
- name: Check formatting
run: cargo fmt --all -- --check
- name: Run clippy
run: cargo clippy --all-targets --all-features -- -D warnings
- name: Run cargo check
run: cargo check --all-targets --all-features
- name: Run unit tests
run: cargo test --lib
- name: Run integration tests
run: cargo test --test integration_test
- name: Build release binary
run: cargo build --release
- name: Test binary help output
shell: bash
run: |
if [[ "${{ runner.os }}" == "Windows" ]]; then
./target/release/cpd.exe --help
./target/release/cpd.exe --version
else
./target/release/cpd --help
./target/release/cpd --version
fi
- name: Test binary functionality (safe commands)
shell: bash
run: |
if [[ "${{ runner.os }}" == "Windows" ]]; then
./target/release/cpd.exe --list-boards || true
else
./target/release/cpd --list-boards || true
fi
coverage:
name: Code Coverage
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Install cargo-tarpaulin
run: cargo install cargo-tarpaulin
- name: Generate code coverage
run: cargo tarpaulin --verbose --all-features --workspace --timeout 120 --out xml
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
file: ./cobertura.xml
fail_ci_if_error: false
security:
name: Security Audit
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Install cargo-audit
run: cargo install cargo-audit
- name: Run security audit
run: cargo audit
minimum-rust-version:
name: Minimum Rust Version
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Rust 1.75.0 (minimum supported)
uses: dtolnay/rust-toolchain@1.75.0
- name: Check build with minimum Rust version
run: cargo check --all-targets --all-features
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Build documentation
run: cargo doc --no-deps --all-features
- name: Check for broken links in docs
run: cargo doc --no-deps --all-features 2>&1 | grep -q "warning" && exit 1 || exit 0