From 8fa14a8952a4d415aaa2edefd5a740d6d637fee3 Mon Sep 17 00:00:00 2001 From: John Pill Date: Wed, 2 Apr 2025 13:10:09 +0100 Subject: [PATCH 1/5] Added interrogate docstring check to run-pre-commit.yml --- .github/workflows/run-pre-commit.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/run-pre-commit.yml b/.github/workflows/run-pre-commit.yml index 22036d5f..959cb4de 100644 --- a/.github/workflows/run-pre-commit.yml +++ b/.github/workflows/run-pre-commit.yml @@ -29,3 +29,8 @@ jobs: pre-commit run black --all-files # TODO enable once all cyclic imports have been fixed # pre-commit run isort --all-files + - 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 + From 55a21d5e05a821e3d4578ac10457e0d78e29e60e Mon Sep 17 00:00:00 2001 From: John Pill Date: Wed, 2 Apr 2025 13:21:13 +0100 Subject: [PATCH 2/5] Update run-pre-commit.yml --- .github/workflows/run-pre-commit.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/run-pre-commit.yml b/.github/workflows/run-pre-commit.yml index 959cb4de..daf9bceb 100644 --- a/.github/workflows/run-pre-commit.yml +++ b/.github/workflows/run-pre-commit.yml @@ -24,13 +24,15 @@ 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: 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 - - 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 - + From 38d72611049a34cd01c898c9ee17ea01a7c738cd Mon Sep 17 00:00:00 2001 From: John Pill Date: Wed, 2 Apr 2025 13:33:54 +0100 Subject: [PATCH 3/5] Update run-pre-commit.yml --- .github/workflows/run-pre-commit.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/run-pre-commit.yml b/.github/workflows/run-pre-commit.yml index daf9bceb..aec751cb 100644 --- a/.github/workflows/run-pre-commit.yml +++ b/.github/workflows/run-pre-commit.yml @@ -29,6 +29,12 @@ jobs: 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@v3 + with: + name: docstring-coverage + path: docstring-coverage.txt - name: pre-commit checks run: | From 438b7ab610c1c5e7db7ceda6fa19366af56a2ae4 Mon Sep 17 00:00:00 2001 From: John Pill Date: Wed, 2 Apr 2025 14:05:13 +0100 Subject: [PATCH 4/5] Update run-pre-commit.yml From 247de880e1cc3487c2aa50df4500e112df86de49 Mon Sep 17 00:00:00 2001 From: John Pill Date: Wed, 2 Apr 2025 14:07:39 +0100 Subject: [PATCH 5/5] Update run-pre-commit.yml --- .github/workflows/run-pre-commit.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/run-pre-commit.yml b/.github/workflows/run-pre-commit.yml index aec751cb..17b0e3f7 100644 --- a/.github/workflows/run-pre-commit.yml +++ b/.github/workflows/run-pre-commit.yml @@ -31,7 +31,7 @@ jobs: 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@v3 + uses: actions/upload-artifact@v4 with: name: docstring-coverage path: docstring-coverage.txt