add rustdoc lints to github actions

reubenwong97 · Aug 26, 2023 · 868cbb3 · 868cbb3
1 parent 9af4bc2
commit 868cbb3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.github/workflows/general.yml b/.github/workflows/general.yml
@@ -39,6 +39,20 @@ jobs:
       - name: Linting
         run: cargo clippy -- -D warnings
 
+  lint:
+    name: Rustdoc-lints
+    runs-on: ubuntu-latest
+    env:
+      RUSTDOCFLAGS: "-D missing_docs -D rustdoc::missing_doc_code_examples"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: doc
+      - uses: Swatinem/rust-cache@v2
+      - name: Rustdoc-linting
+        run: cargo doc --workspace --all-features --no-deps --document-private-items
+
   coverage:
     name: Code coverage
     runs-on: ubuntu-latest

diff --git a/src/main.rs b/src/main.rs
@@ -1,4 +1,5 @@
 #![warn(missing_docs)]
+#![warn(clippy::missing_docs_in_private_items)]
 
 //! Telegram bot for a running contest between friends.
 //!