name: CI
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
release:
types: [ published ]
workflow_dispatch:
env:
CARGO_TERM_COLOR: always
jobs:
lint:
name: Lint and Format Check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
components: rustfmt, clippy, cargo
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-stable-lint-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-stable-lint-
- name: Check code formatting
run: cargo fmt --all -- --check
- name: Run clippy (code smells check)
run: |
cargo clippy --version
# Run clippy with practical code smell checks
# Focus on catching critical issues: debug macros, unsafe patterns, etc.
cargo clippy --all-targets --all-features -- -D warnings \
-D clippy::dbg_macro \
-D clippy::print_stdout \
-D clippy::print_stderr \
-D clippy::todo \
-D clippy::unimplemented \
-D clippy::panic \
-D clippy::exit \
-D clippy::cast_lossless \
-D clippy::cast_possible_truncation \
-D clippy::cast_possible_wrap \
-D clippy::cast_precision_loss \
-D clippy::cast_sign_loss \
-D clippy::clone_on_ref_ptr \
-D clippy::empty_enums \
-D clippy::enum_glob_use \
-D clippy::if_not_else \
-D clippy::mut_mut \
-D clippy::non_ascii_literal \
-D clippy::single_match_else \
-D clippy::string_add \
-D clippy::string_add_assign \
-D clippy::string_lit_as_bytes \
-D clippy::unnecessary_unwrap \
-D clippy::unused_self \
-D clippy::useless_let_if_seq \
-A clippy::module_name_repetitions \
-A clippy::must_use_candidate \
-A clippy::missing_errors_doc \
-A clippy::missing_panics_doc \
-A clippy::too_many_lines \
-A clippy::similar_names \
-A clippy::inline_always \
-A clippy::unwrap_used \
-A clippy::expect_used \
-A clippy::panic \
-A unused_imports \
-A unused_macros \
-A dead_code
- name: Check documentation builds
run: cargo doc --no-deps --all-features --document-private-items
test:
name: Test
runs-on: ubuntu-latest
needs: [lint]
strategy:
matrix:
rust:
- stable
- beta
- nightly
include:
- rust: nightly
allow_failure: true
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
components: rustfmt, clippy, cargo
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ matrix.rust }}-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-${{ matrix.rust }}-
- name: Check formatting
run: cargo fmt --all -- --check
continue-on-error: ${{ matrix.rust == 'nightly' }}
- name: Run clippy
run: |
cargo clippy --version
cargo clippy --all-targets --all-features -- -D warnings \
-D clippy::dbg_macro \
-D clippy::print_stdout \
-D clippy::print_stderr \
-A clippy::unwrap_used \
-A clippy::expect_used \
-A clippy::panic
continue-on-error: ${{ matrix.rust == 'nightly' }}
- name: Run tests
run: cargo test --verbose --all-features
- name: Build
run: cargo build --verbose --release --all-features
build:
name: Build
runs-on: ${{ matrix.os }}
needs: [lint, test]
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
components: rustfmt, clippy, cargo
toolchain: ${{ matrix.rust }}
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-stable-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-stable-
- name: Build
run: cargo build --verbose --release --all-features
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: build-${{ matrix.os }}
path: target/release/
if-no-files-found: ignore
publish:
name: Publish to crates.io
runs-on: ubuntu-latest
needs: [lint, test, build]
if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main')
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
components: rustfmt, clippy, cargo
- name: Run tests
run: cargo test --verbose --all-features
- name: Build
run: cargo build --verbose --release --all-features
- name: Publish to crates.io
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
run: |
cargo publish --verbose --token "${CARGO_REGISTRY_TOKEN}"