Add job to check docstrings

microsoft · Jul 16, 2024 · 9ace7f4 · 9ace7f4
1 parent b9722b5
commit 9ace7f4
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/.github/workflows/list-test.yml b/.github/workflows/list-test.yml
@@ -109,4 +109,21 @@ jobs:
           python -c "from scripts.export_sam_models import dev; dev()"
       - name: Run integration tests
         run: |
-          pytest ./src/vibe_lib ./ops ./src/tests -v --durations=0 --full-trace --junitxml=test-output.xml
+          pytest ./src/vibe_lib ./ops ./src/tests -v --durations=0 --full-trace --junitxml=test-output.xml
+  check-docstrings:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.11'
+    - name: Install ruff
+      run: |
+        pip install ruff
+    - name: "Check docstrings for vibe_core"
+      run: |
+        ruff check --select D,D401 --ignore D105 --force-exclude --exclude src/vibe_core/vibe_core/farmvibes_ai_hello_world.py --config "lint.pydocstyle.convention = 'google'" src/vibe_core/vibe_core/*.py
+    - name: "Check docstrings for vibe_core/data"
+      run: |
+        ruff check --select D,D401 --ignore D105 --config "lint.pydocstyle.convention = 'google'" src/vibe_core/vibe_core/data/*.py