diff --git a/.github/workflows/run-pre-commit.yml b/.github/workflows/run-pre-commit.yml index 22036d5f..17b0e3f7 100644 --- a/.github/workflows/run-pre-commit.yml +++ b/.github/workflows/run-pre-commit.yml @@ -24,8 +24,21 @@ jobs: run: | python -m pip install --upgrade pip pip install .[dev] + + - name: Run docstring checks with interrogate + run: | + python -m pip install interrogate + interrogate -v --fail-under 40 --exclude "tests/*" --exclude "docs/*" --exclude "setup.py" --exclude "scripts/*" --exclude "examples/*" --exclude "*/__init__.py" --exclude "*/__main__.py" --output docstring-coverage.txt + + - name: Upload docstring coverage + uses: actions/upload-artifact@v4 + with: + name: docstring-coverage + path: docstring-coverage.txt + - name: pre-commit checks run: | pre-commit run black --all-files # TODO enable once all cyclic imports have been fixed # pre-commit run isort --all-files +