Add checking autogenerated CLI docs to PR checks

jozu-ai · Mar 5, 2024 · 0a496e8 · 0a496e8
1 parent bf1ea49
commit 0a496e8
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -46,3 +46,12 @@ jobs:
             echo "Project tests failed"
             exit 1
           fi
+
+      - name: Check CLI docs generation
+        run: |
+          docs/src/docs/cli/generate.sh > /dev/null
+          if [[ ! -z $(git status -s) ]]; then
+            echo "CLI documentation is out of date"
+            echo "Run docs/src/docs/cli/generate.sh and commit the result"
+            exit 1
+          fi