Rename structures, add documentation #6
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| name: Rust Validation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| workflow_call: # allow this to be run from other workflows | |
| env: | |
| RUSTDOCFLAGS: -D warnings | |
| RUSTFLAGS: -D warnings | |
| RUST_BACKTRACE: 1 | |
| CARGO_UNSTABLE_SPARSE_REGISTRY: true | |
| jobs: | |
| clippy: | |
| name: clippy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: | | |
| rustup default stable | |
| rustup update | |
| rustup component add clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: cargo clippy --all-features --all-targets -- -D warnings | |
| test: | |
| name: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: | | |
| rustup default stable | |
| rustup update | |
| rustup component add clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: cargo test | |
| fmt: | |
| name: formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: | | |
| rustup default stable | |
| rustup update | |
| rustup component add rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: cargo fmt --all -- --check | |
| doc: | |
| name: docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: | | |
| rustup default nightly | |
| rustup update | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: cargo doc --no-deps |