mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Changed documentation to @r6.
This commit is contained in:
Patrick Lehmann
@@ -58,17 +58,17 @@ Instantiation
|
||||
*************
|
||||
|
||||
The following instantiation example creates a ``ConfigParams`` job derived from job template ``ExtractConfiguration``
|
||||
version ``@r5``. It requires no special parameters to extract unit test (pytest) and code coverage (Coverage.py)
|
||||
version ``@r6``. It requires no special parameters to extract unit test (pytest) and code coverage (Coverage.py)
|
||||
settings.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
jobs:
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
UnitTesting:
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -250,10 +250,10 @@ unittest_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -265,10 +265,10 @@ unittest_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -283,10 +283,10 @@ unittest_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -333,10 +333,10 @@ unittest_merged_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -348,10 +348,10 @@ unittest_merged_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -366,10 +366,10 @@ unittest_merged_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -414,10 +414,10 @@ coverage_report_html
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -429,10 +429,10 @@ coverage_report_html
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -447,10 +447,10 @@ coverage_report_html
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -497,10 +497,10 @@ coverage_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -512,10 +512,10 @@ coverage_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -530,10 +530,10 @@ coverage_report_xml
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -580,10 +580,10 @@ coverage_report_json
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -595,10 +595,10 @@ coverage_report_json
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -613,10 +613,10 @@ coverage_report_json
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -663,10 +663,10 @@ typing_report_cobertura
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -678,10 +678,10 @@ typing_report_cobertura
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -696,10 +696,10 @@ typing_report_cobertura
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -746,10 +746,10 @@ typing_report_junit
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -761,10 +761,10 @@ typing_report_junit
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -779,10 +779,10 @@ typing_report_junit
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -826,10 +826,10 @@ typing_report_html
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -841,10 +841,10 @@ typing_report_html
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
@@ -859,10 +859,10 @@ typing_report_html
|
||||
.. code-block:: yaml
|
||||
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
|
||||
|
||||
OtherJob:
|
||||
uses: some/path/to/a/template@r5
|
||||
uses: some/path/to/a/template@r6
|
||||
needs:
|
||||
- ConfigParams
|
||||
with:
|
||||
|
||||
@@ -53,7 +53,7 @@ Simple Example
|
||||
:columns: 5
|
||||
|
||||
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.
|
||||
``@r6``. It only requires a :ref:`JOBTMPL/Parameters/Input/package_name` parameter to create the artifact names.
|
||||
|
||||
.. grid-item::
|
||||
:columns: 7
|
||||
@@ -62,12 +62,12 @@ Simple Example
|
||||
|
||||
jobs:
|
||||
Params:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_name: myPackage
|
||||
|
||||
UnitTesting:
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r6
|
||||
needs:
|
||||
- Params
|
||||
with:
|
||||
@@ -101,7 +101,7 @@ Complex Example
|
||||
|
||||
jobs:
|
||||
UnitTestingParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_namespace: myFramework
|
||||
package_name: Extension
|
||||
@@ -111,7 +111,7 @@ Complex Example
|
||||
exclude_list: 'windows:pypy-3.10 windows:pypy-3.11'
|
||||
|
||||
PerformanceTestingParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_namespace: myFramework
|
||||
package_name: Extension
|
||||
@@ -119,7 +119,7 @@ Complex Example
|
||||
system_list: 'ubuntu windows macos macos-arm'
|
||||
|
||||
PlatformTestingParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_namespace: myFramework
|
||||
package_name: Extension
|
||||
@@ -272,7 +272,7 @@ package_namespace
|
||||
|
||||
jobs:
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_namespace: myFramework
|
||||
package_name: Extension
|
||||
@@ -321,7 +321,7 @@ package_name
|
||||
|
||||
jobs:
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_name: myPackage
|
||||
|
||||
@@ -404,7 +404,7 @@ include_list
|
||||
|
||||
jobs:
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_name: myPackage
|
||||
include_list: "ubuntu:3.11 macos:3.11"
|
||||
@@ -426,7 +426,7 @@ exclude_list
|
||||
|
||||
jobs:
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_name: myPackage
|
||||
exclude_list: "windows:pypy-3.8 windows:pypy-3.9"
|
||||
@@ -449,7 +449,7 @@ disable_list
|
||||
|
||||
jobs:
|
||||
ConfigParams:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
package_name: myPackage
|
||||
disable_list: "windows:3.10 windows:3.11"
|
||||
@@ -577,12 +577,12 @@ python_version
|
||||
|
||||
jobs:
|
||||
Params:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
name: pyTooling
|
||||
|
||||
CodeCoverage:
|
||||
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r6
|
||||
needs:
|
||||
- Params
|
||||
with:
|
||||
@@ -658,12 +658,12 @@ artifact_names
|
||||
|
||||
jobs:
|
||||
Params:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
name: pyTooling
|
||||
|
||||
Coverage:
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r6
|
||||
needs:
|
||||
- Params
|
||||
with:
|
||||
@@ -692,12 +692,12 @@ python_jobs
|
||||
|
||||
jobs:
|
||||
Params:
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
|
||||
with:
|
||||
name: pyDummy
|
||||
|
||||
UnitTesting:
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r6
|
||||
needs:
|
||||
- Params
|
||||
with:
|
||||
|
||||
@@ -64,7 +64,7 @@ The job template generates various output parameters derived from
|
||||
Instantiation
|
||||
*************
|
||||
|
||||
The following instantiation example creates a ``Prepare`` job derived from job template ``PrepareJob`` version ``@r5``.
|
||||
The following instantiation example creates a ``Prepare`` job derived from job template ``PrepareJob`` version ``@r6``.
|
||||
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.
|
||||
@@ -73,7 +73,7 @@ pull-request titles.
|
||||
|
||||
jobs:
|
||||
Prepare:
|
||||
uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r5
|
||||
uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r6
|
||||
|
||||
<ReleaseJob>:
|
||||
needs:
|
||||
|
||||
Reference in New Issue
Block a user