mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Reduced duplications.
This commit is contained in:
@@ -103,21 +103,7 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/ArtifactCleanup/Input/ubuntu_image_version:
|
.. _JOBTMPL/ArtifactCleanup/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/ArtifactCleanup/Input/package:
|
.. _JOBTMPL/ArtifactCleanup/Input/package:
|
||||||
|
|||||||
@@ -87,21 +87,7 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/IntermediateCleanUp/Input/ubuntu_image_version:
|
.. _JOBTMPL/IntermediateCleanUp/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/IntermediateCleanUp/Input/sqlite_coverage_artifacts_prefix:
|
.. _JOBTMPL/IntermediateCleanUp/Input/sqlite_coverage_artifacts_prefix:
|
||||||
|
|||||||
@@ -119,21 +119,8 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Input/ubuntu_image_version:
|
.. _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 <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.
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Input/latex_artifact:
|
.. _JOBTMPL/LatexDocumentation/Input/latex_artifact:
|
||||||
|
|
||||||
|
|||||||
@@ -133,35 +133,12 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/SphinxDocumentation/Input/ubuntu_image_version:
|
.. _JOBTMPL/SphinxDocumentation/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/SphinxDocumentation/Input/python_version:
|
.. _JOBTMPL/SphinxDocumentation/Input/python_version:
|
||||||
|
|
||||||
python_version
|
.. include:: ../_python_version.rst
|
||||||
==============
|
|
||||||
|
|
||||||
: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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/SphinxDocumentation/Input/requirements:
|
.. _JOBTMPL/SphinxDocumentation/Input/requirements:
|
||||||
|
|||||||
@@ -117,35 +117,12 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/Package/Input/ubuntu_image_version:
|
.. _JOBTMPL/Package/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/Package/Input/python_version:
|
.. _JOBTMPL/Package/Input/python_version:
|
||||||
|
|
||||||
python_version
|
.. include:: ../_python_version.rst
|
||||||
==============
|
|
||||||
|
|
||||||
: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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/Package/Input/requirements:
|
.. _JOBTMPL/Package/Input/requirements:
|
||||||
|
|||||||
@@ -139,35 +139,12 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/PublishOnPyPI/Input/ubuntu_image_version:
|
.. _JOBTMPL/PublishOnPyPI/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/PublishOnPyPI/Input/python_version:
|
.. _JOBTMPL/PublishOnPyPI/Input/python_version:
|
||||||
|
|
||||||
python_version
|
.. include:: ../_python_version.rst
|
||||||
==============
|
|
||||||
|
|
||||||
: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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/PublishOnPyPI/Input/requirements:
|
.. _JOBTMPL/PublishOnPyPI/Input/requirements:
|
||||||
|
|||||||
@@ -164,21 +164,7 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/PublishTestResults/Input/ubuntu_image_version:
|
.. _JOBTMPL/PublishTestResults/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/PublishTestResults/Input/unittest_artifacts_pattern:
|
.. _JOBTMPL/PublishTestResults/Input/unittest_artifacts_pattern:
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ The ``CheckDocumentation`` job checks the level of documentation coverage for Py
|
|||||||
1. Checkout repository.
|
1. Checkout repository.
|
||||||
2. Setup Python environment and install dependencies.
|
2. Setup Python environment and install dependencies.
|
||||||
3. Run ``docstr_coverage``.
|
3. Run ``docstr_coverage``.
|
||||||
3. Run ``interrogate``.
|
4. Run ``interrogate``.
|
||||||
|
|
||||||
.. topic:: Job Execution
|
.. topic:: Job Execution
|
||||||
|
|
||||||
@@ -59,13 +59,13 @@ requires a `name` parameter to create the artifact names.
|
|||||||
needs:
|
needs:
|
||||||
- ConfigParams
|
- ConfigParams
|
||||||
with:
|
with:
|
||||||
directory: ${{ needs.ConfigParams.outputs.package_directory }}
|
directory: ${{ needs.ConfigParams.outputs.package_directory }}
|
||||||
|
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
:ref:`JOBTMPL/ConfigParams`
|
:ref:`JOBTMPL/ExtractConfiguration`
|
||||||
``ConfigParams`` is usualy
|
``ExtractConfiguration`` is usualy used to compute the path to the package's source code directory.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/CheckDocumentation/Parameters:
|
.. _JOBTMPL/CheckDocumentation/Parameters:
|
||||||
@@ -103,35 +103,12 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/CheckDocumentation/Input/ubuntu_image_version:
|
.. _JOBTMPL/CheckDocumentation/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/CheckDocumentation/Input/python_version:
|
.. _JOBTMPL/CheckDocumentation/Input/python_version:
|
||||||
|
|
||||||
python_version
|
.. include:: ../_python_version.rst
|
||||||
==============
|
|
||||||
|
|
||||||
: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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/CheckDocumentation/Input/directory:
|
.. _JOBTMPL/CheckDocumentation/Input/directory:
|
||||||
|
|||||||
@@ -162,35 +162,12 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/ExtractConfiguration/Input/ubuntu_image_version:
|
.. _JOBTMPL/ExtractConfiguration/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/ExtractConfiguration/Input/python_version:
|
.. _JOBTMPL/ExtractConfiguration/Input/python_version:
|
||||||
|
|
||||||
python_version
|
.. include:: ../_python_version.rst
|
||||||
==============
|
|
||||||
|
|
||||||
: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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/ExtractConfiguration/Input/package_namespace:
|
.. _JOBTMPL/ExtractConfiguration/Input/package_namespace:
|
||||||
|
|||||||
@@ -213,21 +213,7 @@ Input Parameters
|
|||||||
|
|
||||||
.. _JOBTMPL/Parameters/Input/ubuntu_image_version:
|
.. _JOBTMPL/Parameters/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 <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.
|
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/Parameters/Input/name:
|
.. _JOBTMPL/Parameters/Input/name:
|
||||||
|
|||||||
10
doc/JobTemplate/_python_version.rst
Normal file
10
doc/JobTemplate/_python_version.rst
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
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 the job.
|
||||||
15
doc/JobTemplate/_ubuntu_image_version.rst
Normal file
15
doc/JobTemplate/_ubuntu_image_version.rst
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
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 the 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.
|
||||||
@@ -80,15 +80,11 @@ ubuntu_image
|
|||||||
:Description: Name of the Ubuntu image used to run a job.
|
: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:
|
.. _JOBTMPL/Common/Input/python_version:
|
||||||
|
|
||||||
python_version
|
.. include:: _python_version.rst
|
||||||
==============
|
|
||||||
|
|
||||||
:Type: string
|
|
||||||
:Required: usually 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 scripts in a job.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user