mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Fix documentation coverage search directory
This commit is contained in:
15
.github/workflows/CheckDocumentation.yml
vendored
15
.github/workflows/CheckDocumentation.yml
vendored
@@ -64,9 +64,20 @@ jobs:
|
|||||||
- name: Run 'interrogate' Documentation Coverage Check
|
- name: Run 'interrogate' Documentation Coverage Check
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
run: |
|
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
|
- name: Run 'docstr_coverage' Documentation Coverage Check
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
run: |
|
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
|
||||||
|
|
||||||
|
|||||||
2
.github/workflows/CompletePipeline.yml
vendored
2
.github/workflows/CompletePipeline.yml
vendored
@@ -193,7 +193,7 @@ jobs:
|
|||||||
- UnitTestingParams
|
- UnitTestingParams
|
||||||
with:
|
with:
|
||||||
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
|
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
|
||||||
directory: ${{ inputs.package_namespace }}/${{ inputs.package_name }}
|
directory: ${{ needs.ConfigParams.outputs.package_directory }}
|
||||||
# fail_below: 70
|
# fail_below: 70
|
||||||
|
|
||||||
Package:
|
Package:
|
||||||
|
|||||||
@@ -53,9 +53,9 @@ class Base:
|
|||||||
_value: int #: An internal value.
|
_value: int #: An internal value.
|
||||||
|
|
||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
"""
|
# """
|
||||||
Initializes the base-class.
|
# Initializes the base-class.
|
||||||
"""
|
# """
|
||||||
self._value = 0
|
self._value = 0
|
||||||
|
|
||||||
@readonly
|
@readonly
|
||||||
@@ -75,9 +75,9 @@ class Application(Base):
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
"""
|
# """
|
||||||
Initializes the dummy application.
|
# Initializes the dummy application.
|
||||||
"""
|
# """
|
||||||
super().__init__()
|
super().__init__()
|
||||||
|
|
||||||
platform = Platform()
|
platform = Platform()
|
||||||
|
|||||||
Reference in New Issue
Block a user