First attempt at checking if README is up to date in CI

usbalbin · Jun 23, 2024 · 41df454 · 41df454
1 parent a4e6ad4
commit 41df454
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/.github/workflows/stable.yml b/.github/workflows/stable.yml
@@ -17,6 +17,22 @@ jobs:
         with:
           command: check
           args: --no-default-features
+
+  readme:
+    name: Readme
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: cargo-readme
+      - name: Generate Readme for comparison
+        run: cargo readme > README_.md
+      - name: Check if readme is up to date
+        run: diff README.md README_.md
 
   test:
     name: Test Suite