Reduced duplications.

This commit is contained in:
Patrick Lehmann
2025-09-08 21:29:39 +02:00
parent 35dd52d018
commit dd30d0bc18
13 changed files with 50 additions and 213 deletions

View File

@@ -15,7 +15,7 @@ The ``CheckDocumentation`` job checks the level of documentation coverage for Py
1. Checkout repository.
2. Setup Python environment and install dependencies.
3. Run ``docstr_coverage``.
3. Run ``interrogate``.
4. Run ``interrogate``.
.. topic:: Job Execution
@@ -59,13 +59,13 @@ requires a `name` parameter to create the artifact names.
needs:
- ConfigParams
with:
directory: ${{ needs.ConfigParams.outputs.package_directory }}
directory: ${{ needs.ConfigParams.outputs.package_directory }}
.. seealso::
:ref:`JOBTMPL/ConfigParams`
``ConfigParams`` is usualy
:ref:`JOBTMPL/ExtractConfiguration`
``ExtractConfiguration`` is usualy used to compute the path to the package's source code directory.
.. _JOBTMPL/CheckDocumentation/Parameters:
@@ -103,35 +103,12 @@ Input Parameters
.. _JOBTMPL/CheckDocumentation/Input/ubuntu_image_version:
ubuntu_image_version
====================
:Type: string
:Required: no
:Default Value: ``'24.04'``
:Possible Values: See `actions/runner-images - Available Images <https://github.com/actions/runner-images?tab=readme-ov-file#available-images>`__
for available Ubuntu image versions.
:Description: Version of the Ubuntu image used to run this job.
.. note::
Unfortunately, GitHub Actions has only a `limited set of functions <https://docs.github.com/en/actions/reference/workflows-and-actions/expressions#functions>`__,
thus, the usual Ubuntu image name like ``'ubuntu-24.04'`` can't be split into image name and image
version.
.. include:: ../_ubuntu_image_version.rst
.. _JOBTMPL/CheckDocumentation/Input/python_version:
python_version
==============
:Type: string
:Required: no
:Default Value: ``'3.13'``
:Possible Values: Any valid Python version conforming to the pattern ``<major>.<minor>`` or ``pypy-<major>.<minor>``. |br|
See `actions/python-versions - available Python versions <https://github.com/actions/python-versions>`__
and `actions/setup-python - configurable Python versions <https://github.com/actions/setup-python>`__.
:Description: Python version used to run Python code in this job.
.. include:: ../_python_version.rst
.. _JOBTMPL/CheckDocumentation/Input/directory: