Specify error types where possible #55
Workflow file for this run
This file contains hidden or 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: | |
| branches: [ main ] | |
| merge_group: | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| rust: [ | |
| 1.91.0, # MSRV | |
| stable, | |
| beta, | |
| nightly, | |
| ] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.rust }} | |
| - name: Test (default) | |
| run: cargo test --verbose | |
| - name: Test (no-std) | |
| run: cargo test --verbose --no-default-features | |
| no_std: | |
| name: No Std | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| # try a target that doesn't have std at all | |
| target: thumbv6m-none-eabi | |
| - run: cargo build --verbose --no-default-features --target thumbv6m-none-eabi | |
| clippy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: clippy | |
| - run: cargo clippy --all-features | |
| fmt: | |
| name: Format | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@1.91.0 | |
| with: | |
| components: rustfmt | |
| - run: cargo fmt --all --check | |
| doc: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@nightly | |
| - run: cargo rustdoc -- --cfg docsrs | |
| # One job that "summarizes" the success state of this pipeline. This can then be added to branch | |
| # protection, rather than having to add each job separately. | |
| success: | |
| name: Success | |
| runs-on: ubuntu-latest | |
| needs: [test, no_std, clippy, fmt, doc] | |
| # Github branch protection is exceedingly silly and treats "jobs skipped because a dependency | |
| # failed" as success. So we have to do some contortions to ensure the job fails if any of its | |
| # dependencies fails. | |
| if: always() # make sure this is never "skipped" | |
| steps: | |
| # Manually check the status of all dependencies. `if: failure()` does not work. | |
| - name: check if any dependency failed | |
| run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}' |