pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-12 02:56:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Changed documentation to @r6.

Browse Source
This commit is contained in:
Patrick Lehmann
2025-09-24 09:53:51 +02:00
parent 53a32fbf35
commit c0547188f9
21 changed files with 148 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/Instantiation.rst
View File

@@ -42,7 +42,7 @@ to handover input parameters to the template.
jobs:
<InstanceName>:
uses: <GitHubOrganization>/<Repository>/.github/workflows/<Template>.yml@r5
uses: <GitHubOrganization>/<Repository>/.github/workflows/<Template>.yml@r6
with:
<Param1>: <Value>
@@ -66,12 +66,12 @@ Documentation Only (Sphinx)
jobs:
BuildTheDocs:
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r5
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r6
with:
artifact: Documentation
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
needs:
- BuildTheDocs
with:

10
doc/JobTemplate/AllInOne/CompletePipeline.rst
View File

@@ -289,7 +289,7 @@ Instantiation
*************
The following instantiation example creates a ``SimplePackage`` job derived from job template ``CompletePipeline``
version ``@r5``. It only requires the `package_name` parameter to run a full pipeline suitable for a Python project.
version ``@r6``. It only requires the `package_name` parameter to run a full pipeline suitable for a Python project.
.. grid:: 2
@@ -307,7 +307,7 @@ version ``@r5``. It only requires the `package_name` parameter to run a full pip
jobs:
SimplePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
with:
package_name: myPackage
@@ -321,7 +321,7 @@ version ``@r5``. It only requires the `package_name` parameter to run a full pip
jobs:
NamespacePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
with:
package_namespace: myFramework
package_name: Extension
@@ -457,7 +457,7 @@ package_namespace
jobs:
NamespacePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
with:
package_namespace: myFramework
package_name: Extension
@@ -505,7 +505,7 @@ package_name
jobs:
SimplePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
with:
package_name: myPackage

4
doc/JobTemplate/Cleanup/ArtifactCleanup.rst
View File

@@ -41,7 +41,7 @@ The simplest variant just uses the artifact name for the package.
jobs:
ArtifactCleanUp:
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r5
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r6
with:
package: Package
@@ -53,7 +53,7 @@ Complex Example
jobs:
ArtifactCleanUp:
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r5
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r6
needs:
- Params
- UnitTesting

4
doc/JobTemplate/Cleanup/IntermediateCleanup.rst
View File

@@ -33,14 +33,14 @@ variant after test results have been merged into a single file.
Instantiation
*************
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r5``. It only
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r6``. It only
requires a `name` parameter to create the artifact names.
.. code-block:: yaml
jobs:
IntermediateCleanUp:
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r5
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r6
needs:
- UnitTestingParams
- PublishCoverageResults

6
doc/JobTemplate/Documentation/LaTeXDocumentation.rst
View File

@@ -46,12 +46,12 @@ Instantiation
jobs:
UnitTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
with:
package_name: myPackage
Documentation:
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
needs:
- UnitTestingParams
with:
@@ -60,7 +60,7 @@ Instantiation
latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
PDFDocumentation:
uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@r5
uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@r6
needs:
- UnitTestingParams
- Documentation

4
doc/JobTemplate/Documentation/PublishToGitHubPages.rst
View File

@@ -51,7 +51,7 @@ Instantiation
# ...
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
needs:
- BuildTheDocs
with:
@@ -66,7 +66,7 @@ Instantiation
jobs:
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
needs:
- Params
- BuildTheDocs

16
doc/JobTemplate/Documentation/SphinxDocumentation.rst
View File

@@ -72,12 +72,12 @@ Instantiation
jobs:
UnitTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
with:
package_name: myPackage
Documentation:
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
needs:
- UnitTestingParams
with:
@@ -199,7 +199,7 @@ coverage_report_json
:Possible Values: Any valid JSON string containing a JSON object with fields:
:directory: Directory or sub-directory where the code coverage JSON report will be extracted from
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/coverage_json_artifact>`.
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/coverage_json_artifact>`.
:Description: Directory as JSON object where the code coverage JSON report will be extracted. |br|
This path is configured in :file:`pyproject.toml` and can be extracted by
:ref:`JOBTMPL/ExtractConfiguration`.
@@ -207,10 +207,10 @@ coverage_report_json
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
Documentation:
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
needs:
- ConfigParams
with:
@@ -245,7 +245,7 @@ unittest_xml
:Possible Values: Any valid JSON string containing a JSON object with fields:
:directory: Directory or sub-directory where the unittest JUnit XML report will be extracted from
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/unittest_xml_artifact>`.
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/unittest_xml_artifact>`.
:Description: Directory as JSON object where the unittest JUnit XML report will be extracted. |br|
This path is configured in :file:`pyproject.toml` and can be extracted by
:ref:`JOBTMPL/ExtractConfiguration`.
@@ -253,10 +253,10 @@ unittest_xml
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
Documentation:
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
needs:
- ConfigParams
with:

4
doc/JobTemplate/Package/Package.rst
View File

@@ -58,7 +58,7 @@ Simple Example
jobs:
Package:
uses: pyTooling/Actions/.github/workflows/Package.yml@r5
uses: pyTooling/Actions/.github/workflows/Package.yml@r6
with:
artifact: Package
@@ -70,7 +70,7 @@ Complex Example
jobs:
Package:
uses: pyTooling/Actions/.github/workflows/Package.yml@r5
uses: pyTooling/Actions/.github/workflows/Package.yml@r6
needs:
- Params
with:

4
doc/JobTemplate/Package/PublishOnPyPI.rst
View File

@@ -63,7 +63,7 @@ by a Git tag. A secret is forwarded from GitHub secrets to a job secret.
# ...
PublishOnPyPI:
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r6
if: startsWith(github.ref, 'refs/tags')
with:
artifact: Package
@@ -87,7 +87,7 @@ by that job. Finally, the list of requirements is overwritten to load a list of
# ...
PublishOnPyPI:
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r6
if: startsWith(github.ref, 'refs/tags')
needs:
- Params

20
doc/JobTemplate/Publish/PublishCoverageResults.rst
View File

@@ -77,17 +77,17 @@ The following
jobs:
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
with:
package_name: myPackage
UnitTestingParams:
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:
- ConfigParams
- UnitTestingParams
@@ -96,7 +96,7 @@ The following
coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
PublishCoverageResults:
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
needs:
- ConfigParams
- UnitTestingParams
@@ -253,10 +253,10 @@ coverage_report_xml
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
PublishCoverageResults:
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
needs:
- ConfigParams
with:
@@ -293,10 +293,10 @@ coverage_report_json
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
PublishCoverageResults:
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
needs:
- ConfigParams
with:
@@ -326,10 +326,10 @@ coverage_report_html
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
PublishCoverageResults:
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
needs:
- ConfigParams
with:

4
doc/JobTemplate/Publish/PublishTestResults.rst
View File

@@ -85,7 +85,7 @@ Simple Example
jobs:
PublishTestResults:
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r6
Complex Example
===============
@@ -100,7 +100,7 @@ Complex Example
# ...
PublishTestResults:
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r6
needs:
- CodeCoverage
- UnitTesting

6
doc/JobTemplate/Quality/CheckDocumentation.rst
View File

@@ -41,19 +41,19 @@ The ``CheckDocumentation`` job checks the level of documentation coverage for Py
Instantiation
*************
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r5``. It only
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r6``. It only
requires a `name` parameter to create the artifact names.
.. code-block:: yaml
jobs:
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
with:
package_name: myPackage
DocCoverage:
uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r5
uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r6
needs:
- ConfigParams
with:

20
doc/JobTemplate/Quality/StaticTypeCheck.rst
View File

@@ -59,7 +59,7 @@ directory ``report/typing``.
jobs:
StaticTypeCheck:
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r6
with:
cobertura_artifact: 'TypeChecking-Cobertura'
junit_artifact: 'TypeChecking-JUnit'
@@ -91,17 +91,17 @@ precompute the artifact's name.
jobs:
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
with:
package_name: myPackage
Params:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
with:
package_name: myPackage
StaticTypeCheck:
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r6
needs:
- ConfigParams
- Params
@@ -221,10 +221,10 @@ cobertura_report
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
UnitTesting:
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r6
needs:
- ConfigParams
with:
@@ -261,10 +261,10 @@ junit_report
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
UnitTesting:
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r6
needs:
- ConfigParams
with:
@@ -294,10 +294,10 @@ html_report
.. code-block:: yaml
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
UnitTesting:
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r6
needs:
- ConfigParams
with:

6
doc/JobTemplate/Release/PublishReleaseNotes.rst
View File

@@ -64,10 +64,10 @@ Instantiation
jobs:
Prepare:
uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r5
uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r6
Release:
uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r6
needs:
- Prepare
if: needs.Prepare.outputs.is_release_tag == 'true'
@@ -441,7 +441,7 @@ replacements
.. code-block:: yaml
ReleasePage:
uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r6
needs:
- Prepare
if: needs.Prepare.outputs.is_release_tag == 'true'

12
doc/JobTemplate/Release/TagReleaseCommit.rst
View File

@@ -47,21 +47,21 @@ Instantiation
*************
The following instantiation example depicts three jobs within a bigger pipeline. The ``prepare`` job derived from job
template ``PrepareJob`` version ``@r5`` figures out if a pipeline runs for a release merge-commit, for a tag or any
template ``PrepareJob`` version ``@r6`` figures out if a pipeline runs for a release merge-commit, for a tag or any
other reason. Its outputs are used to either run a ``TriggerTaggedRelease`` job derived from job template
``TagReleaseCommit`` version ``@r5``, or alternatively run the ``ReleasePage`` job derived from job template
``PublishReleaseNotes`` version ``@r5``.
``TagReleaseCommit`` version ``@r6``, or alternatively run the ``ReleasePage`` job derived from job template
``PublishReleaseNotes`` version ``@r6``.
.. code-block:: yaml
jobs:
Prepare:
uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r5
uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r6
# Other pipeline jobs
TriggerTaggedRelease:
uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@r5
uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@r6
needs:
- Prepare
if: needs.Prepare.outputs.is_release_commit == 'true' && github.event_name != 'schedule'
@@ -74,7 +74,7 @@ other reason. Its outputs are used to either run a ``TriggerTaggedRelease`` job
secrets: inherit
ReleasePage:
uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r5
uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r6
needs:
- Prepare
if: needs.Prepare.outputs.is_release_tag == 'true'

102
doc/JobTemplate/Setup/ExtractConfiguration.rst
View File

@@ -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:

34
doc/JobTemplate/Setup/Parameters.rst
View File

@@ -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:

4
doc/JobTemplate/Setup/PrepareJob.rst
View File

@@ -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:

24
doc/JobTemplate/Testing/UnitTesting.rst
View File

@@ -71,7 +71,7 @@ Instantiation
*************
The following instantiation example creates a ``UnitTesting`` job derived from job template ``UnitTesting`` version
`@r5`. For providing the job matrix as a JSON string, the :ref:`JOBTMPL/Parameters` job template is used. Additionally,
`@r6`. For providing the job matrix as a JSON string, the :ref:`JOBTMPL/Parameters` job template is used. Additionally,
the job needs configuration settings, which are stored in :file:`pyproject.toml`. Instead of duplicating these settings,
the :ref:`JOBTMPL/ExtractConfiguration` job template is used to extract these settings.
@@ -79,15 +79,15 @@ the :ref:`JOBTMPL/ExtractConfiguration` job template is used to extract these se
jobs:
ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
UnitTestingParams:
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:
- ConfigParams
- UnitTestingParams
@@ -513,10 +513,10 @@ unittest_report_xml
.. code-block:: yaml
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:
@@ -564,10 +564,10 @@ coverage_report_xml
.. code-block:: yaml
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:
@@ -604,10 +604,10 @@ coverage_report_json
.. code-block:: yaml
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:
@@ -637,10 +637,10 @@ coverage_report_html
.. code-block:: yaml
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:

2
doc/JobTemplate/index.rst
View File

@@ -45,7 +45,7 @@ Some templates might provide output parameters, which can be used in dependent j
jobs:
<InstanceName>:
uses: <GitHubOrganization>/<Repository>/.github/workflows/<Template>.yml@r5
uses: <GitHubOrganization>/<Repository>/.github/workflows/<Template>.yml@r6
with:
<Param1>: <Value1>
<Param2>: <Value2>

4
doc/index.rst
View File

@@ -121,7 +121,7 @@ Example Pipelines
jobs:
SimplePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
with:
package_name: myPackage
codecov: true
@@ -147,7 +147,7 @@ Example Pipelines
jobs:
NamespacePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
with:
package_namespace: myFramework
package_name: Extension