diff --git a/doc/JobTemplate/Cleanup/ArtifactCleanup.rst b/doc/JobTemplate/Cleanup/ArtifactCleanup.rst index 7147775..4b15b01 100644 --- a/doc/JobTemplate/Cleanup/ArtifactCleanup.rst +++ b/doc/JobTemplate/Cleanup/ArtifactCleanup.rst @@ -103,21 +103,7 @@ Input Parameters .. _JOBTMPL/ArtifactCleanup/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/ArtifactCleanup/Input/package: diff --git a/doc/JobTemplate/Cleanup/IntermediateCleanup.rst b/doc/JobTemplate/Cleanup/IntermediateCleanup.rst index be7fb7b..d5d2840 100644 --- a/doc/JobTemplate/Cleanup/IntermediateCleanup.rst +++ b/doc/JobTemplate/Cleanup/IntermediateCleanup.rst @@ -87,21 +87,7 @@ Input Parameters .. _JOBTMPL/IntermediateCleanUp/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/IntermediateCleanUp/Input/sqlite_coverage_artifacts_prefix: diff --git a/doc/JobTemplate/Documentation/LaTeXDocumentation.rst b/doc/JobTemplate/Documentation/LaTeXDocumentation.rst index 4193ee2..47b344e 100644 --- a/doc/JobTemplate/Documentation/LaTeXDocumentation.rst +++ b/doc/JobTemplate/Documentation/LaTeXDocumentation.rst @@ -119,21 +119,8 @@ Input Parameters .. _JOBTMPL/LatexDocumentation/Input/ubuntu_image_version: -ubuntu_image_version -==================== +.. include:: ../_ubuntu_image_version.rst -: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 this 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. .. _JOBTMPL/LatexDocumentation/Input/latex_artifact: diff --git a/doc/JobTemplate/Documentation/SphinxDocumentation.rst b/doc/JobTemplate/Documentation/SphinxDocumentation.rst index 99d5465..7b69015 100644 --- a/doc/JobTemplate/Documentation/SphinxDocumentation.rst +++ b/doc/JobTemplate/Documentation/SphinxDocumentation.rst @@ -133,35 +133,12 @@ Input Parameters .. _JOBTMPL/SphinxDocumentation/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/SphinxDocumentation/Input/python_version: -python_version -============== - -:Type: string -:Required: no -:Default Value: ``'3.13'`` -:Possible Values: Any valid Python version conforming to the pattern ``.`` or ``pypy-.``. |br| - See `actions/python-versions - available Python versions `__ - and `actions/setup-python - configurable Python versions `__. -:Description: Python version used to run Python code in this job. +.. include:: ../_python_version.rst .. _JOBTMPL/SphinxDocumentation/Input/requirements: diff --git a/doc/JobTemplate/Package/Package.rst b/doc/JobTemplate/Package/Package.rst index 3fa2a24..f295909 100644 --- a/doc/JobTemplate/Package/Package.rst +++ b/doc/JobTemplate/Package/Package.rst @@ -117,35 +117,12 @@ Input Parameters .. _JOBTMPL/Package/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/Package/Input/python_version: -python_version -============== - -:Type: string -:Required: no -:Default Value: ``'3.13'`` -:Possible Values: Any valid Python version conforming to the pattern ``.`` or ``pypy-.``. |br| - See `actions/python-versions - available Python versions `__ - and `actions/setup-python - configurable Python versions `__. -:Description: Python version used to run Python code in this job. +.. include:: ../_python_version.rst .. _JOBTMPL/Package/Input/requirements: diff --git a/doc/JobTemplate/Package/PublishOnPyPI.rst b/doc/JobTemplate/Package/PublishOnPyPI.rst index eed98e3..45d99bd 100644 --- a/doc/JobTemplate/Package/PublishOnPyPI.rst +++ b/doc/JobTemplate/Package/PublishOnPyPI.rst @@ -139,35 +139,12 @@ Input Parameters .. _JOBTMPL/PublishOnPyPI/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/PublishOnPyPI/Input/python_version: -python_version -============== - -:Type: string -:Required: no -:Default Value: ``'3.13'`` -:Possible Values: Any valid Python version conforming to the pattern ``.`` or ``pypy-.``. |br| - See `actions/python-versions - available Python versions `__ - and `actions/setup-python - configurable Python versions `__. -:Description: Python version used to run Python code in this job. +.. include:: ../_python_version.rst .. _JOBTMPL/PublishOnPyPI/Input/requirements: diff --git a/doc/JobTemplate/Publish/PublishTestResults.rst b/doc/JobTemplate/Publish/PublishTestResults.rst index 6dca46e..ff8f4ce 100644 --- a/doc/JobTemplate/Publish/PublishTestResults.rst +++ b/doc/JobTemplate/Publish/PublishTestResults.rst @@ -164,21 +164,7 @@ Input Parameters .. _JOBTMPL/PublishTestResults/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/PublishTestResults/Input/unittest_artifacts_pattern: diff --git a/doc/JobTemplate/Quality/CheckDocumentation.rst b/doc/JobTemplate/Quality/CheckDocumentation.rst index 86088b4..9993b11 100644 --- a/doc/JobTemplate/Quality/CheckDocumentation.rst +++ b/doc/JobTemplate/Quality/CheckDocumentation.rst @@ -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 `__ - 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 `__, - 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 ``.`` or ``pypy-.``. |br| - See `actions/python-versions - available Python versions `__ - and `actions/setup-python - configurable Python versions `__. -:Description: Python version used to run Python code in this job. +.. include:: ../_python_version.rst .. _JOBTMPL/CheckDocumentation/Input/directory: diff --git a/doc/JobTemplate/Setup/ExtractConfiguration.rst b/doc/JobTemplate/Setup/ExtractConfiguration.rst index b8ab9f3..0cdbf9f 100644 --- a/doc/JobTemplate/Setup/ExtractConfiguration.rst +++ b/doc/JobTemplate/Setup/ExtractConfiguration.rst @@ -162,35 +162,12 @@ Input Parameters .. _JOBTMPL/ExtractConfiguration/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/ExtractConfiguration/Input/python_version: -python_version -============== - -:Type: string -:Required: no -:Default Value: ``'3.13'`` -:Possible Values: Any valid Python version conforming to the pattern ``.`` or ``pypy-.``. |br| - See `actions/python-versions - available Python versions `__ - and `actions/setup-python - configurable Python versions `__. -:Description: Python version used to run Python code in this job. +.. include:: ../_python_version.rst .. _JOBTMPL/ExtractConfiguration/Input/package_namespace: diff --git a/doc/JobTemplate/Setup/Parameters.rst b/doc/JobTemplate/Setup/Parameters.rst index 114c557..6a8ac20 100644 --- a/doc/JobTemplate/Setup/Parameters.rst +++ b/doc/JobTemplate/Setup/Parameters.rst @@ -213,21 +213,7 @@ Input Parameters .. _JOBTMPL/Parameters/Input/ubuntu_image_version: -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 this 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. +.. include:: ../_ubuntu_image_version.rst .. _JOBTMPL/Parameters/Input/name: diff --git a/doc/JobTemplate/_python_version.rst b/doc/JobTemplate/_python_version.rst new file mode 100644 index 0000000..f137334 --- /dev/null +++ b/doc/JobTemplate/_python_version.rst @@ -0,0 +1,10 @@ +python_version +============== + +:Type: string +:Required: no +:Default Value: ``'3.13'`` +:Possible Values: Any valid Python version conforming to the pattern ``.`` or ``pypy-.``. |br| + 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. diff --git a/doc/JobTemplate/_ubuntu_image_version.rst b/doc/JobTemplate/_ubuntu_image_version.rst new file mode 100644 index 0000000..62dc3ec --- /dev/null +++ b/doc/JobTemplate/_ubuntu_image_version.rst @@ -0,0 +1,15 @@ +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. diff --git a/doc/JobTemplate/index.rst b/doc/JobTemplate/index.rst index e53db4a..099fe29 100644 --- a/doc/JobTemplate/index.rst +++ b/doc/JobTemplate/index.rst @@ -80,15 +80,11 @@ ubuntu_image :Description: Name of the Ubuntu image used to run a job. +.. _JOBTMPL/Common/Input/ubuntu_image_version: + +.. include:: _ubuntu_image_version.rst + + .. _JOBTMPL/Common/Input/python_version: -python_version -============== - -:Type: string -:Required: usually no -:Default Value: ``'3.13'`` -:Possible Values: Any valid Python version conforming to the pattern ``.`` or ``pypy-.``. |br| - See `actions/python-versions - available Python versions `__ - and `actions/setup-python - configurable Python versions `__. -:Description: Python version used to run Python scripts in a job. +.. include:: _python_version.rst