chore: Fix docs warnings (#156) #501
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 | |
| env: | |
| RUST_BACKTRACE: 1 | |
| jobs: | |
| ci-pass: | |
| name: CI is green | |
| runs-on: ubuntu-latest | |
| needs: | |
| - style | |
| - test | |
| - msrv | |
| - miri | |
| - features | |
| - semver | |
| - doc | |
| steps: | |
| - run: exit 0 | |
| style: | |
| name: Check Style | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt | |
| - run: cargo fmt --all --check | |
| test: | |
| name: Test ${{ matrix.rust }} on ${{ matrix.os }} | |
| needs: [style] | |
| strategy: | |
| matrix: | |
| rust: | |
| - stable | |
| - beta | |
| - nightly | |
| os: | |
| - ubuntu-latest | |
| - windows-latest | |
| - macos-latest | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Rust (${{ matrix.rust }}) | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.rust }} | |
| - run: cargo test --all-features | |
| msrv: | |
| name: Check MSRV (${{ matrix.rust }}) | |
| needs: [style] | |
| strategy: | |
| matrix: | |
| rust: [ 1.63 ] # keep in sync with 'rust-version' in Cargo.toml | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Rust (${{ matrix.rust }}) | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.rust }} | |
| - name: Pin some dependencies for MSRV | |
| run: | | |
| cargo update | |
| cargo update --package tokio --precise 1.38.1 | |
| cargo update --package tokio-util --precise 0.7.11 | |
| - run: cargo check --features full | |
| miri: | |
| name: Test with Miri | |
| needs: [style] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@nightly | |
| with: | |
| components: miri | |
| - name: Test | |
| env: | |
| # Can't enable tcp feature since Miri does not support the tokio runtime | |
| MIRIFLAGS: "-Zmiri-disable-isolation" | |
| run: cargo miri test --all-features | |
| features: | |
| name: features | |
| needs: [style] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: taiki-e/install-action@cargo-hack | |
| - run: cargo hack --no-dev-deps check --feature-powerset --depth 2 | |
| semver: | |
| name: semver | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check semver | |
| uses: obi1kenobi/cargo-semver-checks-action@v2 | |
| with: | |
| feature-group: only-explicit-features | |
| features: full | |
| release-type: minor | |
| doc: | |
| name: Build docs | |
| needs: [style, test] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@nightly | |
| - run: cargo rustdoc -- --cfg docsrs -D rustdoc::broken-intra-doc-links |