Merge pull request 'Updates for docs' (#8) from docs-updates into main #1
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, pull_request] | |
| jobs: | |
| check: | |
| name: Check build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| targets: "thumbv7em-none-eabihf" | |
| - run: cargo check --target thumbv7em-none-eabihf --release | |
| - run: cargo check --target thumbv7em-none-eabihf --examples --release | |
| test: | |
| name: Run Tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - name: Install nextest | |
| uses: taiki-e/install-action@nextest | |
| - run: cargo nextest run --all-features -p va416xx-hal | |
| # I think we can skip those on an embedded crate.. | |
| # - run: cargo test --doc -p va108xx-hal | |
| fmt: | |
| name: Check formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo fmt --all -- --check | |
| docs: | |
| name: Check Documentation Build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@nightly | |
| - run: RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features | |
| clippy: | |
| name: Clippy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| targets: "thumbv7em-none-eabihf" | |
| - run: cargo clippy --target thumbv7em-none-eabihf -- -D warnings |