ci(doc consistency): check that lib.rs and README.md are consistent

Nahor · Mar 4, 2024 · a085c16 · a085c16
1 parent 22b29ee
commit a085c16
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,6 +16,11 @@ jobs:
         with:
           toolchain: stable
           components: rustfmt
+      - name: Check doc consistency
+        shell: bash
+        run: |
+            cargo install cargo-readme
+            diff -q README.md <(cargo readme)
       - name: rustfmt
         run: cargo fmt --all -- --check
       - name: docs