Skip to content

chore: update docs

chore: update docs #30

Workflow file for this run

name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
env:
# Disable incremental compilation for faster from-scratch builds
CARGO_INCREMENTAL: 0
CARGO_PROFILE_TEST_DEBUG: 0
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
cancel-in-progress: true
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- name: Check License Header
uses: korandoru/hawkeye@v6
with:
config: licenserc.toml
- name: Fmt check
run: cargo fmt --all -- --check
- name: Clippy
run: cargo clippy --locked --all-targets --workspace -- -D warnings
build:
runs-on: ${{ matrix.os }}
env:
CARGO_PROFILE_RELEASE_LTO: true
CARGO_PROFILE_RELEASE_CODEGEN_UNITS: 1
strategy:
matrix:
os:
- ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Build
run: cargo build --release --locked
unit:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- uses: taiki-e/install-action@nextest
- run: cargo check --locked
- name: Test
run: cargo nextest run --locked --workspace --all-features --no-tests=pass
env:
RUST_LOG: DEBUG
RUST_BACKTRACE: full