name: CI
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
env:
CARGO_TERM_COLOR: always
RUSTFLAGS: -Dwarnings
jobs:
test:
name: Test Suite
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
rust: [stable, beta]
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust }}
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-${{ matrix.rust }}-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-${{ matrix.rust }}-
- name: Run unit tests
run: cargo test --lib --all-features --verbose
- name: Run integration tests
run: cargo test --test integration_tests --all-features --verbose
- name: Run cross-SDK tests
run: cargo test --test cross_sdk_tests --all-features --verbose
- name: Run sighash tests
run: cargo test --test sighash_tests --all-features --verbose
- name: Run EC tests
run: cargo test --test ec_tests --all-features --verbose
- name: Run doc tests
run: cargo test --doc --all-features
clippy:
name: Clippy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
with:
components: clippy
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ubuntu-clippy-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
ubuntu-clippy-
- name: Run Clippy
run: cargo clippy --all-targets --all-features -- -D warnings
fmt:
name: Rustfmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt
- name: Check formatting
run: cargo fmt --all -- --check
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ubuntu-docs-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
ubuntu-docs-
- name: Build docs
run: cargo doc --no-deps --all-features
env:
RUSTDOCFLAGS: -Dwarnings
benchmarks:
name: Benchmark Regression Check
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-bench-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-bench-
- name: Install critcmp
run: cargo install critcmp
- name: Benchmark main branch
run: |
git checkout ${{ github.base_ref }}
cargo bench --bench primitives_bench --bench hash_bench -- --save-baseline main
- name: Benchmark PR branch
run: |
git checkout ${{ github.head_ref }}
cargo bench --bench primitives_bench --bench hash_bench -- --save-baseline pr
- name: Compare benchmarks
run: |
critcmp main pr
benchmarks-build:
name: Benchmarks Build
runs-on: ubuntu-latest
if: github.event_name == 'push'
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-bench-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-bench-
- name: Build benchmarks
run: cargo bench --no-run