Skip to content

Commit

Permalink
ci(rustdoc): check rustdoc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
ROMemories authored and kaspar030 committed Feb 23, 2024
1 parent 231bdb4 commit e045c66
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,24 @@ jobs:
with:
args: --verbose --locked -p riot-rs-embassy

rustdoc:
runs-on: ubuntu-latest

steps:
- name: Check out repository code
uses: actions/checkout@v4

- name: Install toolchain
uses: dtolnay/rust-toolchain@nightly

- name: rust cache
uses: Swatinem/rust-cache@v2

# TODO: we'll eventually want to generate docs for riot-rs instead
# TODO: we'll eventually want to enable relevant features
- name: "rustdoc generation check"
run: cargo rustdoc -p riot-rs-embassy -- -D warnings

CI-success:
if: ${{ always() }}
runs-on: ubuntu-latest
Expand Down

0 comments on commit e045c66

Please sign in to comment.