README: give an example of output + add docs link #75
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: "main" | |
| on: | |
| pull_request: | |
| branches: | |
| - "*" | |
| push: | |
| branches: | |
| - "*" | |
| jobs: | |
| hygiene: | |
| name: Hygiene | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| toolchain: [stable, beta, nightly] | |
| include: | |
| - os: macos-latest | |
| toolchain: stable | |
| - os: windows-latest | |
| toolchain: stable | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Acquire source code | |
| uses: actions/checkout@v2 | |
| - name: Acquire Rust toolchain | |
| uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| override: true | |
| profile: minimal | |
| components: rustfmt, clippy | |
| id: toolchain | |
| - name: Cache cargo registry | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cargo/registry | |
| key: checks-${{ runner.os }}-cargo-registry-trimmed | |
| - name: Cache cargo git trees | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cargo/git | |
| key: checks-${{ runner.os }}-cargo-gits-trimmed | |
| - name: Cache cargo build | |
| uses: actions/cache@v3 | |
| with: | |
| path: target | |
| key: checks-${{ runner.os }}-cargo-target-dir-${{ steps.toolchain.outputs.rustc_hash }} | |
| - name: "Run clippy" | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: clippy | |
| args: --all --tests -- -D clippy::all -D warnings | |
| - name: "Run formatting check" | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: fmt | |
| args: --all -- --check | |
| build: | |
| name: "Build/Test" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| toolchain: [nightly, beta, stable] | |
| include: | |
| - os: macos-latest | |
| toolchain: stable | |
| - os: windows-latest | |
| toolchain: stable | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Acquire source code | |
| uses: actions/checkout@v2 | |
| - name: Acquire Rust toolchain | |
| uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| override: true | |
| profile: minimal | |
| id: toolchain | |
| - name: Cache cargo registry | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cargo/registry | |
| key: checks-${{ runner.os }}-cargo-registry-trimmed | |
| - name: Cache cargo git trees | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cargo/git | |
| key: checks-${{ runner.os }}-cargo-gits-trimmed | |
| - name: Cache cargo build | |
| uses: actions/cache@v3 | |
| with: | |
| path: target | |
| key: checks-${{ runner.os }}-cargo-target-dir-${{ steps.toolchain.outputs.rustc_hash }} | |
| - name: "Set backtraces on" | |
| run: echo "RUST_BACKTRACE=1" >> $GITHUB_ENV | |
| - name: "Run build" | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: build | |
| args: --all | |
| - name: "Run tests" | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: test | |
| args: --all |