doc: streamline device path documentation between uefi-raw and uefi #4779
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: QA | |
on: [merge_group, push, pull_request] | |
jobs: | |
spellcheck: | |
name: Spellcheck | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
# Executes "typos ." | |
- uses: crate-ci/[email protected] | |
lints: | |
name: Lints | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout sources | |
uses: actions/checkout@v4 | |
- uses: cachix/install-nix-action@v31 | |
- uses: Swatinem/rust-cache@v2 | |
# Dedicated step to separate all the | |
# "copying path '/nix/store/...' from 'https://cache.nixos.org'." | |
# messages from the actual build output. | |
- name: Prepare Nix Store | |
run: nix develop --command echo | |
# A dedicated step removes spam from the actual job. | |
- name: Build cargo xtask | |
run: cargo xtask help >/dev/null | |
# Executing this in a Nix shell ensures that all our checks run as all | |
# required tooling exists. | |
- name: Check formatting | |
run: | | |
CMD="cargo xtask fmt --check" | |
nix develop --command bash -c "$CMD" | |
- name: Run clippy | |
run: | | |
rustup component add clippy | |
cargo xtask clippy --warnings-as-errors | |
- name: Run cargo doc (without unstable) | |
run: cargo xtask doc --warnings-as-errors --document-private-items | |
- name: Verify generated code is up-to-date | |
run: cargo xtask gen-code --check | |
- name: Run additional checks on the uefi-raw package | |
run: cargo xtask check-raw |