Skip to content

Commit c054718

Browse files
PaebbelsPaebbels
committed
Changed documentation to @r6.
1 parent 53a32fb commit c054718

21 files changed

Lines changed: 148 additions & 148 deletions

‎doc/Instantiation.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ to handover input parameters to the template.
4242
4343
jobs:
4444
<InstanceName>:
45-
uses: <GitHubOrganization>/<Repository>/.github/workflows/<Template>.yml@r5
45+
uses: <GitHubOrganization>/<Repository>/.github/workflows/<Template>.yml@r6
4646
with:
4747
<Param1>: <Value>
4848
@@ -66,12 +66,12 @@ Documentation Only (Sphinx)
6666
6767
jobs:
6868
BuildTheDocs:
69-
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r5
69+
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r6
7070
with:
7171
artifact: Documentation
7272
7373
PublishToGitHubPages:
74-
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
74+
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
7575
needs:
7676
- BuildTheDocs
7777
with:

‎doc/JobTemplate/AllInOne/CompletePipeline.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ Instantiation
289289
*************
290290

291291
The following instantiation example creates a ``SimplePackage`` job derived from job template ``CompletePipeline``
292-
version ``@r5``. It only requires the `package_name` parameter to run a full pipeline suitable for a Python project.
292+
version ``@r6``. It only requires the `package_name` parameter to run a full pipeline suitable for a Python project.
293293

294294
.. grid:: 2
295295

@@ -307,7 +307,7 @@ version ``@r5``. It only requires the `package_name` parameter to run a full pip
307307
308308
jobs:
309309
SimplePackage:
310-
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
310+
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
311311
with:
312312
313313
package_name: myPackage
@@ -321,7 +321,7 @@ version ``@r5``. It only requires the `package_name` parameter to run a full pip
321321
322322
jobs:
323323
NamespacePackage:
324-
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
324+
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
325325
with:
326326
package_namespace: myFramework
327327
package_name: Extension
@@ -457,7 +457,7 @@ package_namespace
457457
458458
jobs:
459459
NamespacePackage:
460-
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
460+
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
461461
with:
462462
package_namespace: myFramework
463463
package_name: Extension
@@ -505,7 +505,7 @@ package_name
505505
506506
jobs:
507507
SimplePackage:
508-
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
508+
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6
509509
with:
510510
package_name: myPackage
511511

‎doc/JobTemplate/Cleanup/ArtifactCleanup.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The simplest variant just uses the artifact name for the package.
4141
4242
jobs:
4343
ArtifactCleanUp:
44-
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r5
44+
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r6
4545
with:
4646
package: Package
4747
@@ -53,7 +53,7 @@ Complex Example
5353
5454
jobs:
5555
ArtifactCleanUp:
56-
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r5
56+
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r6
5757
needs:
5858
- Params
5959
- UnitTesting

‎doc/JobTemplate/Cleanup/IntermediateCleanup.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ variant after test results have been merged into a single file.
3333
Instantiation
3434
*************
3535

36-
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r5``. It only
36+
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r6``. It only
3737
requires a `name` parameter to create the artifact names.
3838

3939
.. code-block:: yaml
4040
4141
jobs:
4242
IntermediateCleanUp:
43-
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r5
43+
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r6
4444
needs:
4545
- UnitTestingParams
4646
- PublishCoverageResults

‎doc/JobTemplate/Documentation/LaTeXDocumentation.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ Instantiation
4646
4747
jobs:
4848
UnitTestingParams:
49-
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
49+
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
5050
with:
5151
package_name: myPackage
5252
5353
Documentation:
54-
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
54+
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
5555
needs:
5656
- UnitTestingParams
5757
with:
@@ -60,7 +60,7 @@ Instantiation
6060
latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
6161
6262
PDFDocumentation:
63-
uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@r5
63+
uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@r6
6464
needs:
6565
- UnitTestingParams
6666
- Documentation

‎doc/JobTemplate/Documentation/PublishToGitHubPages.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Instantiation
5151
# ...
5252
5353
PublishToGitHubPages:
54-
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
54+
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
5555
needs:
5656
- BuildTheDocs
5757
with:
@@ -66,7 +66,7 @@ Instantiation
6666
6767
jobs:
6868
PublishToGitHubPages:
69-
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
69+
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
7070
needs:
7171
- Params
7272
- BuildTheDocs

‎doc/JobTemplate/Documentation/SphinxDocumentation.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ Instantiation
7272
7373
jobs:
7474
UnitTestingParams:
75-
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
75+
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
7676
with:
7777
package_name: myPackage
7878
7979
Documentation:
80-
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
80+
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
8181
needs:
8282
- UnitTestingParams
8383
with:
@@ -199,18 +199,18 @@ coverage_report_json
199199
:Possible Values: Any valid JSON string containing a JSON object with fields:
200200

201201
:directory: Directory or sub-directory where the code coverage JSON report will be extracted from
202-
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/coverage_json_artifact>`.
202+
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/coverage_json_artifact>`.
203203
:Description: Directory as JSON object where the code coverage JSON report will be extracted. |br|
204204
This path is configured in :file:`pyproject.toml` and can be extracted by
205205
:ref:`JOBTMPL/ExtractConfiguration`.
206206
:Example:
207207
.. code-block:: yaml
208208
209209
ConfigParams:
210-
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
210+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
211211
212212
Documentation:
213-
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
213+
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
214214
needs:
215215
- ConfigParams
216216
with:
@@ -245,18 +245,18 @@ unittest_xml
245245
:Possible Values: Any valid JSON string containing a JSON object with fields:
246246

247247
:directory: Directory or sub-directory where the unittest JUnit XML report will be extracted from
248-
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/unittest_xml_artifact>`.
248+
:ref:`artifact <JOBTMPL/SphinxDocumentation/Input/unittest_xml_artifact>`.
249249
:Description: Directory as JSON object where the unittest JUnit XML report will be extracted. |br|
250250
This path is configured in :file:`pyproject.toml` and can be extracted by
251251
:ref:`JOBTMPL/ExtractConfiguration`.
252252
:Example:
253253
.. code-block:: yaml
254254
255255
ConfigParams:
256-
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
256+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
257257
258258
Documentation:
259-
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r5
259+
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
260260
needs:
261261
- ConfigParams
262262
with:

‎doc/JobTemplate/Package/Package.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Simple Example
5858
5959
jobs:
6060
Package:
61-
uses: pyTooling/Actions/.github/workflows/Package.yml@r5
61+
uses: pyTooling/Actions/.github/workflows/Package.yml@r6
6262
with:
6363
artifact: Package
6464
@@ -70,7 +70,7 @@ Complex Example
7070
7171
jobs:
7272
Package:
73-
uses: pyTooling/Actions/.github/workflows/Package.yml@r5
73+
uses: pyTooling/Actions/.github/workflows/Package.yml@r6
7474
needs:
7575
- Params
7676
with:

‎doc/JobTemplate/Package/PublishOnPyPI.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ by a Git tag. A secret is forwarded from GitHub secrets to a job secret.
6363
# ...
6464
6565
PublishOnPyPI:
66-
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r5
66+
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r6
6767
if: startsWith(github.ref, 'refs/tags')
6868
with:
6969
artifact: Package
@@ -87,7 +87,7 @@ by that job. Finally, the list of requirements is overwritten to load a list of
8787
# ...
8888
8989
PublishOnPyPI:
90-
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r5
90+
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r6
9191
if: startsWith(github.ref, 'refs/tags')
9292
needs:
9393
- Params

‎doc/JobTemplate/Publish/PublishCoverageResults.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,17 @@ The following
7777
7878
jobs:
7979
ConfigParams:
80-
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
80+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
8181
with:
8282
package_name: myPackage
8383
8484
UnitTestingParams:
85-
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
85+
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
8686
with:
8787
package_name: myPackage
8888
8989
UnitTesting:
90-
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r5
90+
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r6
9191
needs:
9292
- ConfigParams
9393
- UnitTestingParams
@@ -96,7 +96,7 @@ The following
9696
coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
9797
9898
PublishCoverageResults:
99-
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
99+
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
100100
needs:
101101
- ConfigParams
102102
- UnitTestingParams
@@ -253,10 +253,10 @@ coverage_report_xml
253253
.. code-block:: yaml
254254
255255
ConfigParams:
256-
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
256+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
257257
258258
PublishCoverageResults:
259-
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
259+
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
260260
needs:
261261
- ConfigParams
262262
with:
@@ -293,10 +293,10 @@ coverage_report_json
293293
.. code-block:: yaml
294294
295295
ConfigParams:
296-
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
296+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
297297
298298
PublishCoverageResults:
299-
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
299+
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
300300
needs:
301301
- ConfigParams
302302
with:
@@ -326,10 +326,10 @@ coverage_report_html
326326
.. code-block:: yaml
327327
328328
ConfigParams:
329-
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
329+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r6
330330
331331
PublishCoverageResults:
332-
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r5
332+
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r6
333333
needs:
334334
- ConfigParams
335335
with:

0 commit comments

Comments
 (0)