more docs #104
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: CI | |
| on: | |
| push: | |
| branches: [master] | |
| pull_request: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| fmt: | |
| runs-on: ubuntu-latest | |
| name: stable / fmt | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install stable | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt | |
| - name: cargo fmt --check | |
| run: cargo fmt --check | |
| clippy: | |
| runs-on: ubuntu-latest | |
| name: ${{ matrix.toolchain }} / clippy | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| toolchain: [stable, beta] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install ${{ matrix.toolchain }} | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| components: clippy | |
| - uses: actions-rs/cargo@v1 | |
| with: | |
| command: clippy | |
| args: -- -D warnings | |
| doc: | |
| runs-on: ubuntu-latest | |
| name: nightly / doc | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install nightly | |
| uses: dtolnay/rust-toolchain@nightly | |
| - name: cargo doc | |
| run: cargo doc --no-deps --all-features | |
| env: | |
| RUSTDOCFLAGS: --cfg docsrs | |
| test: | |
| runs-on: ubuntu-latest | |
| name: ${{ matrix.toolchain }} / test | |
| strategy: | |
| matrix: | |
| toolchain: [stable, beta] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install ${{ matrix.toolchain }} | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| - name: Rust cache | |
| uses: Swatinem/rust-cache@v2 | |
| - name: cargo test | |
| run: cargo test --all-features --all-targets | |
| - name: cargo test --doc | |
| run: cargo test --all-features --doc | |
| coverage: | |
| runs-on: ubuntu-latest | |
| name: stable / coverage | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install stable | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: llvm-tools-preview | |
| - name: Rust cache | |
| uses: Swatinem/rust-cache@v2 | |
| - name: cargo install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - run: cargo llvm-cov --all-features --workspace |