fix: typos in documentation #1136
Workflow file for this run
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 | |
| - "release/**" | |
| pull_request: | |
| jobs: | |
| lints: | |
| name: Lints | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - run: rustup component add rustfmt clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Run cargo fmt | |
| run: cargo fmt --all -- --check | |
| - name: Run cargo clippy | |
| run: cargo clippy --all-features --workspace --tests --examples -- -D clippy::all | |
| check: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| name: Check feature permutations using Rust stable on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: make checkall | |
| test: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| name: Test using Rust stable on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Run cargo test | |
| run: cargo test --workspace --all-features --all-targets | |
| MSRV: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| rust: [1.73.0] | |
| name: Check / Test MSRV on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - name: Install rust ${{ matrix.rust }} toolchain | |
| run: | | |
| rustup toolchain install ${{ matrix.rust }} --profile minimal --no-self-update | |
| rustup default ${{ matrix.rust }} | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: make checkfast | |
| - run: make testfast | |
| codecov: | |
| name: Code Coverage | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - run: rustup component add llvm-tools-preview | |
| - uses: Swatinem/rust-cache@v2 | |
| - uses: taiki-e/install-action@cargo-llvm-cov | |
| - run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info | |
| - uses: codecov/codecov-action@e156083f13aff6830c92fc5faa23505779fbf649 | |
| with: | |
| files: lcov.info | |
| doc: | |
| name: Build-test documentation | |
| runs-on: ubuntu-latest | |
| env: | |
| RUSTDOCFLAGS: -Dwarnings | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - run: rustup component add rust-docs | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Run cargo doc | |
| run: cargo doc --workspace --all-features --document-private-items --no-deps |