Expand docs and copy edit #90
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: | |
| pull_request: | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| check-msrv: | |
| name: Check | |
| strategy: | |
| matrix: | |
| toolchain: | |
| - "1.70" | |
| - stable | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Remove the rust-toolchain.toml | |
| # `rustup` will attempt to use the toolchain from | |
| # the file which will conflict with the custom versions | |
| # we use in the matrix. | |
| run: rm rust-toolchain.toml | |
| - name: Install toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.toolchain}} | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Run cargo check | |
| run: | | |
| rustc --version | |
| cargo check | |
| test: | |
| name: Test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Remove the rust-toolchain.toml | |
| run: rm rust-toolchain.toml | |
| - name: Install stable toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Check rust version | |
| run: rustc --version | |
| - name: Run cargo test | |
| run: cargo test | |
| lints: | |
| name: Lints | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Remove the rust-toolchain.toml | |
| run: rm rust-toolchain.toml | |
| - name: Install stable toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt, clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Check rust version | |
| run: rustc --version | |
| - name: Run cargo fmt | |
| run: cargo fmt --check | |
| - name: Run cargo clippy with default features | |
| run: cargo clippy -- -D warnings | |
| - name: Run cargo clippy with no default features | |
| run: cargo clippy --no-default-features -- -D warnings | |
| - name: Run cargo doc | |
| run: cargo doc --no-deps --document-private-items | |
| env: | |
| RUSTDOCFLAGS: -D warnings |