docs: add linkable header to example configurations #1658
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 | |
| permissions: | |
| contents: read | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - master | |
| env: | |
| RUST_BACKTRACE: 1 | |
| CARGO_TERM_COLOR: always | |
| CLICOLOR: 1 | |
| COLUMNS: 130 | |
| concurrency: | |
| group: "${{ github.workflow }}-${{ github.ref }}" | |
| cancel-in-progress: true | |
| jobs: | |
| ci: | |
| permissions: | |
| contents: none | |
| name: CI | |
| needs: [test, msrv, lockfile, docs, rustfmt, clippy] | |
| runs-on: ubuntu-latest | |
| if: "always()" | |
| steps: | |
| - name: Failed | |
| run: exit 1 | |
| if: "contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') || contains(needs.*.result, 'skipped')" | |
| test: | |
| name: Test | |
| strategy: | |
| matrix: | |
| os: ["ubuntu-latest", "windows-latest", "macos-latest"] | |
| rust: ["stable"] | |
| continue-on-error: ${{ matrix.rust != 'stable' }} | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: ${{ matrix.rust }} | |
| components: rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| - uses: taiki-e/install-action@cargo-hack | |
| - name: Build | |
| run: cargo test --workspace --no-run | |
| - name: Test | |
| run: cargo hack test --feature-powerset --workspace | |
| msrv: | |
| name: "Check MSRV" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - uses: taiki-e/install-action@cargo-hack | |
| - name: Default features | |
| run: cargo hack check --feature-powerset --locked --rust-version --ignore-private --workspace --all-targets | |
| lockfile: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Is lockfile updated?" | |
| run: cargo update --workspace --locked | |
| docs: | |
| name: Docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: "1.83" # STABLE | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Check documentation | |
| env: | |
| RUSTDOCFLAGS: -D warnings | |
| run: cargo doc --workspace --all-features --no-deps --document-private-items | |
| rustfmt: | |
| name: rustfmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: "1.83" # STABLE | |
| components: rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Check formatting | |
| run: cargo fmt --all -- --check | |
| clippy: | |
| name: clippy | |
| runs-on: ubuntu-latest | |
| permissions: | |
| security-events: write # to upload sarif results | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: "1.83" # STABLE | |
| components: clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install SARIF tools | |
| run: cargo install clippy-sarif --locked | |
| - name: Install SARIF tools | |
| run: cargo install sarif-fmt --locked | |
| - name: Check | |
| run: > | |
| cargo clippy --workspace --all-features --all-targets --message-format=json | |
| | clippy-sarif | |
| | tee clippy-results.sarif | |
| | sarif-fmt | |
| continue-on-error: true | |
| - name: Upload | |
| uses: github/codeql-action/upload-sarif@v3 | |
| with: | |
| sarif_file: clippy-results.sarif | |
| wait-for-processing: true | |
| - name: Report status | |
| run: cargo clippy --workspace --all-features --all-targets -- -D warnings --allow deprecated | |
| coverage: | |
| name: Coverage | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install cargo-tarpaulin | |
| run: cargo install cargo-tarpaulin | |
| - name: Gather coverage | |
| run: cargo tarpaulin --output-dir coverage --out lcov | |
| - name: Publish to Coveralls | |
| uses: coverallsapp/github-action@master | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} |