From 4ebf262921634bfb085345824b2e2f41da9d4273 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Sat, 26 Apr 2025 18:50:07 +0200 Subject: [PATCH] Fix documentation coverage search directory --- .github/workflows/CheckDocumentation.yml | 15 +++++++++++++-- .github/workflows/CompletePipeline.yml | 2 +- pyDummy/__init__.py | 12 ++++++------ 3 files changed, 20 insertions(+), 9 deletions(-) diff --git a/.github/workflows/CheckDocumentation.yml b/.github/workflows/CheckDocumentation.yml index 2eef1f2..6b6205f 100644 --- a/.github/workflows/CheckDocumentation.yml +++ b/.github/workflows/CheckDocumentation.yml @@ -64,9 +64,20 @@ jobs: - name: Run 'interrogate' Documentation Coverage Check continue-on-error: true run: | - interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} && printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})" + set +e + + interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} + if [[ $? -ne 0 ]]; then + printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})" + fi - name: Run 'docstr_coverage' Documentation Coverage Check continue-on-error: true run: | - docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} && printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})" + set +e + + docstr-coverage --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} + if [[ $? -ne 0 ]]; then + printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})" + fi + diff --git a/.github/workflows/CompletePipeline.yml b/.github/workflows/CompletePipeline.yml index 5e36b26..a89e947 100644 --- a/.github/workflows/CompletePipeline.yml +++ b/.github/workflows/CompletePipeline.yml @@ -193,7 +193,7 @@ jobs: - UnitTestingParams with: python_version: ${{ needs.UnitTestingParams.outputs.python_version }} - directory: ${{ inputs.package_namespace }}/${{ inputs.package_name }} + directory: ${{ needs.ConfigParams.outputs.package_directory }} # fail_below: 70 Package: diff --git a/pyDummy/__init__.py b/pyDummy/__init__.py index 636ed39..2b2eff5 100644 --- a/pyDummy/__init__.py +++ b/pyDummy/__init__.py @@ -53,9 +53,9 @@ class Base: _value: int #: An internal value. def __init__(self) -> None: - """ - Initializes the base-class. - """ + # """ + # Initializes the base-class. + # """ self._value = 0 @readonly @@ -75,9 +75,9 @@ class Application(Base): """ def __init__(self) -> None: - """ - Initializes the dummy application. - """ + # """ + # Initializes the dummy application. + # """ super().__init__() platform = Platform()