mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Reworked UnitTesting.
This commit is contained in:
@@ -42,7 +42,7 @@ The ``ExtractConfiguration`` job template is a .....
|
||||
Instantiation
|
||||
*************
|
||||
|
||||
The following instantiation example creates a job ``ConfigParams`` derived from job template ``ExtractConfiguration``
|
||||
The following instantiation example creates a ``ConfigParams`` job derived from job template ``ExtractConfiguration``
|
||||
version ``@r5``. It only requires a :ref:`JOBTMPL/ExtractConfiguration/Input/package_name` parameter to extract unit
|
||||
test (pytest) and code coverage (Coverage.py) settings.
|
||||
|
||||
@@ -594,7 +594,7 @@ coverage_report_json
|
||||
output = "report/coverage/coverage.json"
|
||||
|
||||
|
||||
.. _JOBTMPL/LatexDocumentation/Optimizations:
|
||||
.. _JOBTMPL/ExtractConfiguration/Optimizations:
|
||||
|
||||
Optimizations
|
||||
*************
|
||||
|
||||
@@ -37,7 +37,7 @@ Simple Example
|
||||
.. grid-item::
|
||||
:columns: 5
|
||||
|
||||
The following instantiation example creates a job ``Params`` derived from job template ``Parameters`` version
|
||||
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version
|
||||
``@r5``. It only requires a :ref:`JOBTMPL/Parameters/Input/package_name` parameter to create the artifact names.
|
||||
|
||||
.. grid-item::
|
||||
@@ -74,15 +74,15 @@ Complex Example
|
||||
|
||||
The following instantiation example creates 3 jobs from the same template, but with differing input parameters.
|
||||
|
||||
The first job ``UnitTestingParams`` might be used to create a job matrix of unit tests. It creates the cross of
|
||||
The first ``UnitTestingParams`` job might be used to create a job matrix of unit tests. It creates the cross of
|
||||
default systems (Windows, Ubuntu, macOS, macOS-ARM, MinGW64, UCRT64) and the given list of Python versions
|
||||
including some mypy versions. In addition a list of excludes (marked as :deletion:`deletions`) and includes
|
||||
(marked as :addition:`additions`) is handed over resulting in the following combinations.
|
||||
|
||||
The second job ``PerformanceTestingParams`` might be used to create a job matrix for performance tests. Here a
|
||||
The second ``PerformanceTestingParams`` job might be used to create a job matrix for performance tests. Here a
|
||||
pipeline might be limited to the latest two Python versions on a selected list of platforms.
|
||||
|
||||
The third job ``PlatformTestingParams`` might be used to create a job matrix for platform compatibility tests.
|
||||
The third ``PlatformTestingParams`` job might be used to create a job matrix for platform compatibility tests.
|
||||
Here a pipeline might be limited to the latest Python version, but all available platforms.
|
||||
|
||||
.. grid-item::
|
||||
@@ -742,7 +742,7 @@ params
|
||||
* ``params['doc']`` |rarr| ``artifact_names['documentation_html']``
|
||||
|
||||
|
||||
.. _JOBTMPL/LatexDocumentation/Optimizations:
|
||||
.. _JOBTMPL/Parameters/Optimizations:
|
||||
|
||||
Optimizations
|
||||
*************
|
||||
|
||||
@@ -55,7 +55,7 @@ The job template generates various output parameters derived from
|
||||
Instantiation
|
||||
*************
|
||||
|
||||
The following instantiation example creates a job ``Prepare`` derived from job template ``PrepareJob`` version ``@r5``.
|
||||
The following instantiation example creates a ``Prepare`` job derived from job template ``PrepareJob`` version ``@r5``.
|
||||
In a default usecase, no input parameters need to be specified for the job template assuming a main-branch and
|
||||
release-branch called ``main``, a development-branch called ``dev``, as well as semantic versioning for tags and
|
||||
pull-request titles.
|
||||
@@ -451,7 +451,7 @@ pr_number
|
||||
empty string ``''``.
|
||||
|
||||
|
||||
.. _JOBTMPL/LatexDocumentation/Optimizations:
|
||||
.. _JOBTMPL/PrepareJob/Optimizations:
|
||||
|
||||
Optimizations
|
||||
*************
|
||||
|
||||
Reference in New Issue
Block a user