CheckDocumentation

The CheckDocumentation job checks the level of documentation coverage for Python files.

Instantiation

The following instantiation example creates a Params job derived from job template Parameters version @r6. It only requires a name parameter to create the artifact names.

jobs:
  ConfigParams:
    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
    with:
      package_name: myPackage

  DocCoverage:
    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r6
    needs:
      - ConfigParams
    with:
      directory: ${{ needs.ConfigParams.outputs.package_directory }}

Parameter Summary

Goto input parameters

Parameter Name	Required	Type	Default
ubuntu_image_version	no	string	`'24.04'`
python_version	no	string	`'3.14'`
directory	yes	string	— — — —
fail_under	no	string	`'80'`

Goto secrets

This job template needs no secrets.

Goto output parameters

This job template has no output parameters.

Input Parameters

ubuntu_image_version

Type:: string
Required:: no
Default Value:: '24.04'
Possible Values:: See actions/runner-images - Available Images for available Ubuntu image versions.
Description:: Version of the Ubuntu image used to run the job.

Note

Unfortunately, GitHub Actions has only a limited set of functions, thus, the usual Ubuntu image name like 'ubuntu-24.04' can’t be split into image name and image version.

python_version

Type:: string
Required:: no
Default Value:: '3.14'
Possible Values:: Any valid Python version conforming to the pattern <major>.<minor> or pypy-<major>.<minor>.
See actions/python-versions - available Python versions and actions/setup-python - configurable Python versions.
Description:: Python version used to run Python code in the job.

directory

Type:: string
Required:: yes
Default Value:: — — — —
Possible Values:: Any valid directory or sub-directory.
Description:: Directory where the Python code is located.

fail_under

Type:: string
Required:: no
Default Value:: '80'
Possible Values:: Any valid percentage from 0 to 100 encoded as string.
Description:: A minimum percentage level for good documentation. If the documentation coverage is below this level, the coverage is considered a fail.

Secrets

This job template needs no secrets.

Outputs

This job template has no output parameters.