Improve README.md, add CONTRIBUTING.md, and more!
#230
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: [main] | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| # Find the nightly Rust version and required components from `rust-toolchain.toml` using | |
| # <https://taplo.tamasfe.dev>, so that we install can install them in later jobs. | |
| extract-rust-version: | |
| name: Extract Rust version | |
| runs-on: ubuntu-latest | |
| outputs: | |
| channel: ${{ steps.toolchain.outputs.toolchain }} | |
| components: ${{ steps.toolchain.outputs.components }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Taplo | |
| run: | | |
| curl -fsSL https://github.com/tamasfe/taplo/releases/latest/download/taplo-linux-x86_64.gz \ | |
| | gzip -d - | install -m 755 /dev/stdin /usr/local/bin/taplo | |
| - name: Extract toolchain | |
| id: toolchain | |
| run: | | |
| TOOLCHAIN=$(taplo get -f='rust-toolchain.toml' 'toolchain.channel') | |
| COMPONENTS=$(taplo get -f='rust-toolchain.toml' --separator=', ' 'toolchain.components') | |
| echo toolchain=$TOOLCHAIN >> $GITHUB_OUTPUT | |
| echo components=$COMPONENTS >> $GITHUB_OUTPUT | |
| test: | |
| name: Run tests | |
| needs: extract-rust-version | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ needs.extract-rust-version.outputs.channel }} | |
| components: ${{ needs.extract-rust-version.outputs.components }} | |
| - name: Cache build artifacts | |
| uses: Leafwing-Studios/cargo-cache@v2 | |
| with: | |
| sweep-cache: true | |
| - name: Run tests | |
| run: | | |
| cargo test --workspace --all-features --all-targets | |
| # Workaround for https://github.com/rust-lang/cargo/issues/6669. `--doc` is incompatible | |
| # with `--all-targets`, so we run them separately. | |
| cargo test --workspace --all-features --doc | |
| clippy: | |
| name: Check with Clippy | |
| needs: extract-rust-version | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ needs.extract-rust-version.outputs.channel }} | |
| components: '${{ needs.extract-rust-version.outputs.components }}, clippy' | |
| - name: Cache build artifacts | |
| uses: Leafwing-Studios/cargo-cache@v2 | |
| with: | |
| sweep-cache: true | |
| - name: Run Clippy | |
| run: cargo clippy --workspace --all-targets --all-features -- --deny warnings | |
| rustfmt: | |
| name: Check with rustfmt | |
| needs: extract-rust-version | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ needs.extract-rust-version.outputs.channel }} | |
| components: '${{ needs.extract-rust-version.outputs.components }}, rustfmt' | |
| - name: Run rustfmt | |
| run: cargo fmt --all --check | |
| docs: | |
| name: Build docs | |
| needs: extract-rust-version | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ needs.extract-rust-version.outputs.channel }} | |
| components: ${{ needs.extract-rust-version.outputs.components }} | |
| - name: Cache build artifacts | |
| uses: Leafwing-Studios/cargo-cache@v2 | |
| with: | |
| sweep-cache: true | |
| - name: Build documentation | |
| run: cargo doc --workspace --all-features --document-private-items --no-deps | |
| typos: | |
| name: Check for typos | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Check for typos | |
| id: typos | |
| uses: crate-ci/[email protected] | |
| - name: Print help on failure | |
| if: ${{ failure() && steps.typos.conclusion == 'failure' }} | |
| run: | | |
| echo 'To fix typos, please run `typos -w`.' | |
| echo 'To check for a diff, run `typos`.' | |
| echo 'You can install `typos` at <https://crates.io/crates/typos>.' |