Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci(rustdoc): check rustdoc generation #113

Merged
merged 1 commit into from
Feb 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading