Add github action to catch badly formated docs

1Password · Jul 30, 2024 · 827ae65 · 827ae65
1 parent 440b3c8
commit 827ae65
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -42,6 +42,22 @@ jobs:
           components: rustfmt
       - run: rustup run ${{ matrix.rust}} cargo fmt --all -- --check
 
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rust:
+          - stable
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: ${{ matrix.rust }}
+          components: rustdoc
+      - run: RUSTDOCFLAGS="-D warnings " rustup run ${{ matrix }} cargo doc --workspace --locked --no-deps --all-features
+
   test:
     name: Test
     runs-on: ubuntu-latest
@@ -56,7 +72,7 @@ jobs:
         with:
           profile: minimal
           toolchain: ${{ matrix.rust }}
-      - run: rustup run ${{ matrix.rust }} cargo test 
+      - run: rustup run ${{ matrix.rust }} cargo test
 
   typeshare:
     name: Typeshare

diff --git a/passkey-types/src/ctap2/get_assertion.rs b/passkey-types/src/ctap2/get_assertion.rs
@@ -10,7 +10,10 @@ use crate::{
 pub use crate::ctap2::make_credential::Options;
 
 #[cfg(doc)]
-use crate::webauthn::{CollectedClientData, PublicKeyCredentialRequestOptions};
+use {
+    crate::webauthn::{CollectedClientData, PublicKeyCredentialRequestOptions},
+    ciborium::Value,
+};
 
 use super::extensions::{AuthenticatorPrfGetOutputs, AuthenticatorPrfInputs, HmacGetSecretInput};