You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/01/16 20:25:05 UTC

[streampipes] 02/02: chore: add doc check to pr-validation

This is an automated email from the ASF dual-hosted git repository.

bossenti pushed a commit to branch chore/python-dependencies
in repository https://gitbox.apache.org/repos/asf/streampipes.git

commit 8c6cce6763f29165043a0174e516f72775e3ee6b
Author: bossenti <bo...@posteo.de>
AuthorDate: Mon Jan 16 21:24:47 2023 +0100

    chore: add doc check to pr-validation
---
 .github/workflows/pr-validation.yml | 36 ++++++++++++++++++++++++++++++++----
 1 file changed, 32 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml
index 07ace7096..90bc06e31 100644
--- a/.github/workflows/pr-validation.yml
+++ b/.github/workflows/pr-validation.yml
@@ -131,12 +131,10 @@ jobs:
       - name: Run style & code checks
         run: |
           cd ./streampipes-client-python
-          pre-commit run --files streampipes_client/*
-          pre-commit run --files tests/*
+          pre-commit run -a
           make mypy
           make lint
 
-
   python-unit-tests:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -171,4 +169,34 @@ jobs:
       - name: Run unit-tests
         run: |
           cd ./streampipes-client-python
-          make unit-tests
\ No newline at end of file
+          make unit-tests
+
+  python-doc-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Cache Python dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip${{ hashFiles('**/setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install Python dependencies
+        run: |
+          cd ./streampipes-client-python
+          python -m pip install --upgrade pip
+          pip install wheel
+          pip install -e ".[docs]"
+
+      - name: Build MkDocs
+        run: |
+          cd ./streampipes-client-python
+          make doc
\ No newline at end of file