From 92ce8343034eb183297e9e5aa6c85306aac3ae93 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Wed, 19 Jun 2024 00:09:27 +0200 Subject: [PATCH] Added input parameter 'fail_under' for CheckDocumentation. --- .github/workflows/CheckDocumentation.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/CheckDocumentation.yml b/.github/workflows/CheckDocumentation.yml index c092b5cb..a2a11b07 100644 --- a/.github/workflows/CheckDocumentation.yml +++ b/.github/workflows/CheckDocumentation.yml @@ -33,11 +33,11 @@ on: description: 'Source code directory to check.' required: true type: string -# fail_below: -# description: 'Minimum required documentation coverage level' -# required: false -# default: 75 -# type: string + fail_under: + description: 'Minimum required documentation coverage level' + required: false + default: 80 + type: string jobs: DocCoverage: @@ -59,9 +59,9 @@ jobs: - name: Run 'interrogate' Documentation Coverage Check continue-on-error: true run: | - interrogate -c pyproject.toml + interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} - name: Run 'docstr_coverage' Documentation Coverage Check continue-on-error: true run: | - docstr_coverage -v ${{ inputs.directory }} + docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}