mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Corrections after consistency, spelling and grammar check by Gemini.
This commit is contained in:
@@ -43,7 +43,7 @@ It can be used for simple Python packages as well as namespace packages.
|
|||||||
|
|
||||||
* GitHub Pipeline Summary
|
* GitHub Pipeline Summary
|
||||||
|
|
||||||
* Publich unittest results using :gh:`dorny/test-reporter`.
|
* Publish unittest results using :gh:`dorny/test-reporter`.
|
||||||
|
|
||||||
* GitHub Pages
|
* GitHub Pages
|
||||||
|
|
||||||
@@ -689,7 +689,7 @@ apptest_exclude_list
|
|||||||
:Default Value: ``'windows-arm:3.9 windows-arm:3.10'``
|
:Default Value: ``'windows-arm:3.9 windows-arm:3.10'``
|
||||||
:Possible Values: A space separated list of ``<system>:<python_version>`` tuples.
|
:Possible Values: A space separated list of ``<system>:<python_version>`` tuples.
|
||||||
:Description: List of space-separated ``<system>:<python_version>`` tuples to be excluded from the list of
|
:Description: List of space-separated ``<system>:<python_version>`` tuples to be excluded from the list of
|
||||||
appliation test variants.
|
application test variants.
|
||||||
|
|
||||||
For more details see :ref:`JOBTMPL/Parameters/Input/exclude_list`.
|
For more details see :ref:`JOBTMPL/Parameters/Input/exclude_list`.
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
ArtifactCleanUp
|
ArtifactCleanUp
|
||||||
###############
|
###############
|
||||||
|
|
||||||
This job removes artifacts which were used to exchange data from job to job.
|
This job removes artifacts which were used to exchange data between jobs.
|
||||||
|
|
||||||
.. topic:: Features
|
.. topic:: Features
|
||||||
|
|
||||||
|
|||||||
@@ -35,18 +35,17 @@ requires a `name` parameter to create the artifact names.
|
|||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
name: Pipeline
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Params:
|
IntermediateCleanUp:
|
||||||
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
|
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r5
|
||||||
|
needs:
|
||||||
|
- UnitTestingParams
|
||||||
|
- PublishCoverageResults
|
||||||
|
- PublishTestResults
|
||||||
|
if: success() || failure()
|
||||||
with:
|
with:
|
||||||
name: pyTooling
|
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
|
||||||
|
xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
.. _JOBTMPL/LatexDocumentation:
|
.. _JOBTMPL/LaTeXDocumentation:
|
||||||
|
|
||||||
LatexDocumentation
|
LaTeXDocumentation
|
||||||
##################
|
##################
|
||||||
|
|
||||||
The ``LatexDocumentation`` job template downloads an artifact containing a LaTeX document and translates to a PDF file
|
The ``LaTeXDocumentation`` job template downloads an artifact containing a LaTeX document and translates to a PDF file
|
||||||
using MikTeX.
|
using MikTeX.
|
||||||
|
|
||||||
The translation process uses ``latexmk`` for handling multiple passes. The default LaTeX processor is ``xelatex``, but
|
The translation process uses ``latexmk`` for handling multiple passes. The default LaTeX processor is ``xelatex``, but
|
||||||
@@ -34,7 +34,7 @@ can be switched by a parameter.
|
|||||||
* :dockerhub:`pytooling/miktex <pytooling/miktex:sphinx>`
|
* :dockerhub:`pytooling/miktex <pytooling/miktex:sphinx>`
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Instantiation:
|
.. _JOBTMPL/LaTeXDocumentation/Instantiation:
|
||||||
|
|
||||||
Instantiation
|
Instantiation
|
||||||
*************
|
*************
|
||||||
@@ -73,47 +73,47 @@ Instantiation
|
|||||||
pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
|
pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Parameters:
|
.. _JOBTMPL/LaTeXDocumentation/Parameters:
|
||||||
|
|
||||||
Parameter Summary
|
Parameter Summary
|
||||||
*****************
|
*****************
|
||||||
|
|
||||||
.. rubric:: Goto :ref:`input parameters <JOBTMPL/LatexDocumentation/Inputs>`
|
.. rubric:: Goto :ref:`input parameters <JOBTMPL/LaTeXDocumentation/Inputs>`
|
||||||
|
|
||||||
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
||||||
| Parameter Name | Required | Type | Default |
|
| Parameter Name | Required | Type | Default |
|
||||||
+=====================================================================+==========+==========+===================================================================+
|
+=====================================================================+==========+==========+===================================================================+
|
||||||
| :ref:`JOBTMPL/LatexDocumentation/Input/ubuntu_image_version` | no | string | ``'24.04'`` |
|
| :ref:`JOBTMPL/LaTeXDocumentation/Input/ubuntu_image_version` | no | string | ``'24.04'`` |
|
||||||
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
||||||
| :ref:`JOBTMPL/LatexDocumentation/Input/latex_artifact` | yes | string | — — — — |
|
| :ref:`JOBTMPL/LaTeXDocumentation/Input/latex_artifact` | yes | string | — — — — |
|
||||||
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
||||||
| :ref:`JOBTMPL/LatexDocumentation/Input/document` | yes | string | — — — — |
|
| :ref:`JOBTMPL/LaTeXDocumentation/Input/document` | yes | string | — — — — |
|
||||||
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
||||||
| :ref:`JOBTMPL/LatexDocumentation/Input/processor` | no | string | ``'xelatex'`` |
|
| :ref:`JOBTMPL/LaTeXDocumentation/Input/processor` | no | string | ``'xelatex'`` |
|
||||||
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
||||||
| :ref:`JOBTMPL/LatexDocumentation/Input/pdf_artifact` | no | string | ``''`` |
|
| :ref:`JOBTMPL/LaTeXDocumentation/Input/pdf_artifact` | no | string | ``''`` |
|
||||||
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
|
||||||
|
|
||||||
.. rubric:: Goto :ref:`secrets <JOBTMPL/LatexDocumentation/Secrets>`
|
.. rubric:: Goto :ref:`secrets <JOBTMPL/LaTeXDocumentation/Secrets>`
|
||||||
|
|
||||||
This job template needs no secrets.
|
This job template needs no secrets.
|
||||||
|
|
||||||
.. rubric:: Goto :ref:`output parameters <JOBTMPL/LatexDocumentation/Outputs>`
|
.. rubric:: Goto :ref:`output parameters <JOBTMPL/LaTeXDocumentation/Outputs>`
|
||||||
|
|
||||||
This job template has no output parameters.
|
This job template has no output parameters.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Inputs:
|
.. _JOBTMPL/LaTeXDocumentation/Inputs:
|
||||||
|
|
||||||
Input Parameters
|
Input Parameters
|
||||||
****************
|
****************
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Input/ubuntu_image_version:
|
.. _JOBTMPL/LaTeXDocumentation/Input/ubuntu_image_version:
|
||||||
|
|
||||||
.. include:: ../_ubuntu_image_version.rst
|
.. include:: ../_ubuntu_image_version.rst
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Input/latex_artifact:
|
.. _JOBTMPL/LaTeXDocumentation/Input/latex_artifact:
|
||||||
|
|
||||||
latex_artifact
|
latex_artifact
|
||||||
==============
|
==============
|
||||||
@@ -125,7 +125,7 @@ latex_artifact
|
|||||||
:Description: Name of the artifact containing the LaTeX document to translate.
|
:Description: Name of the artifact containing the LaTeX document to translate.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Input/document:
|
.. _JOBTMPL/LaTeXDocumentation/Input/document:
|
||||||
|
|
||||||
document
|
document
|
||||||
========
|
========
|
||||||
@@ -137,7 +137,7 @@ document
|
|||||||
:Description: Name of the LaTeX document
|
:Description: Name of the LaTeX document
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Input/processor:
|
.. _JOBTMPL/LaTeXDocumentation/Input/processor:
|
||||||
|
|
||||||
processor
|
processor
|
||||||
=========
|
=========
|
||||||
@@ -149,7 +149,7 @@ processor
|
|||||||
:Description: Name of the used LaTeX processor.
|
:Description: Name of the used LaTeX processor.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Input/pdf_artifact:
|
.. _JOBTMPL/LaTeXDocumentation/Input/pdf_artifact:
|
||||||
|
|
||||||
pdf_artifact
|
pdf_artifact
|
||||||
============
|
============
|
||||||
@@ -164,7 +164,7 @@ pdf_artifact
|
|||||||
|
|
||||||
If this parameter is empty, no PDF file will be generated and no artifact will be uploaded.
|
If this parameter is empty, no PDF file will be generated and no artifact will be uploaded.
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Secrets:
|
.. _JOBTMPL/LaTeXDocumentation/Secrets:
|
||||||
|
|
||||||
Secrets
|
Secrets
|
||||||
*******
|
*******
|
||||||
@@ -172,7 +172,7 @@ Secrets
|
|||||||
This job template needs no secrets.
|
This job template needs no secrets.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Outputs:
|
.. _JOBTMPL/LaTeXDocumentation/Outputs:
|
||||||
|
|
||||||
Outputs
|
Outputs
|
||||||
*******
|
*******
|
||||||
@@ -180,7 +180,7 @@ Outputs
|
|||||||
This job template has no output parameters.
|
This job template has no output parameters.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/LatexDocumentation/Optimizations:
|
.. _JOBTMPL/LaTeXDocumentation/Optimizations:
|
||||||
|
|
||||||
Optimizations
|
Optimizations
|
||||||
*************
|
*************
|
||||||
@@ -188,4 +188,4 @@ Optimizations
|
|||||||
The following optimizations can be used to reduce the template's runtime.
|
The following optimizations can be used to reduce the template's runtime.
|
||||||
|
|
||||||
Disable PDF generation and PDF artifact
|
Disable PDF generation and PDF artifact
|
||||||
If parameter :ref:`JOBTMPL/LatexDocumentation/Input/pdf_artifact` is empty, no PDF will be generated and uploaded.
|
If parameter :ref:`JOBTMPL/LaTeXDocumentation/Input/pdf_artifact` is empty, no PDF will be generated and uploaded.
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ This job template publishes HTML content from artifacts of other jobs to GitHub
|
|||||||
* :gh:`actions/download-artifact`
|
* :gh:`actions/download-artifact`
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/Parameters/Instantiation:
|
.. _JOBTMPL/PublishToGitHubPages/Instantiation:
|
||||||
|
|
||||||
Instantiation
|
Instantiation
|
||||||
*************
|
*************
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ and a LaTeX documentation. This LaTeX document can be translated using e.g. MikT
|
|||||||
1. Checkout repository.
|
1. Checkout repository.
|
||||||
2. Install system dependencies.
|
2. Install system dependencies.
|
||||||
3. Setup Python environment and install Python dependencies.
|
3. Setup Python environment and install Python dependencies.
|
||||||
4. Download optional artifacts for integration of futher reports into the documentation.
|
4. Download optional artifacts for integration of further reports into the documentation.
|
||||||
5. Build the HTML documentation using Sphinx.
|
5. Build the HTML documentation using Sphinx.
|
||||||
6. Build the LaTeX documentation using Sphinx.
|
6. Build the LaTeX documentation using Sphinx.
|
||||||
|
|
||||||
@@ -281,6 +281,6 @@ The following optimizations can be used to reduce the template's runtime.
|
|||||||
Disable HTML website generation and HTML artifact
|
Disable HTML website generation and HTML artifact
|
||||||
If parameter :ref:`JOBTMPL/SphinxDocumentation/Input/html_artifact` is empty, no HTML website will be generated and
|
If parameter :ref:`JOBTMPL/SphinxDocumentation/Input/html_artifact` is empty, no HTML website will be generated and
|
||||||
uploaded.
|
uploaded.
|
||||||
Disable LaTeX document generation and laTeX artifact
|
Disable LaTeX document generation and LaTeX artifact
|
||||||
If parameter :ref:`JOBTMPL/SphinxDocumentation/Input/latex_artifact` is empty, no LaTeX document will be generated and
|
If parameter :ref:`JOBTMPL/SphinxDocumentation/Input/latex_artifact` is empty, no LaTeX document will be generated and
|
||||||
uploaded.
|
uploaded.
|
||||||
|
|||||||
@@ -13,15 +13,16 @@ Supported services are:
|
|||||||
|
|
||||||
.. topic:: Features
|
.. topic:: Features
|
||||||
|
|
||||||
* Package source code as wheel and source distribution.
|
* Merge multiple JUnit XML reports generated by pytest into a single JUnit XML report.
|
||||||
* Support packaging using :pypi:`build` (recommended) or :pypi:`setuptools`.
|
* Publish unit test results to currently running pipeline as job result.
|
||||||
|
* Publish unit test results to CodeCov.
|
||||||
|
|
||||||
.. topic:: Behavior
|
.. topic:: Behavior
|
||||||
|
|
||||||
1. Checkout repository
|
1. Checkout repository
|
||||||
2. Download multiple artifacts containing test report summaries in JUnit XML format conforming to an artifact name
|
2. Download multiple artifacts containing test report summaries in JUnit XML format conforming to an artifact name
|
||||||
pattern (see :ref:`JOBTMPL/PublishTestResults/Input/unittest_artifacts_pattern`) for limiting the number of
|
pattern (see :ref:`JOBTMPL/PublishTestResults/Input/unittest_artifacts_pattern`) for limiting the number of
|
||||||
downloaded artifacts and the herby generated traffic.
|
downloaded artifacts and the hereby generated traffic.
|
||||||
3. Rename the found JUnit XML files.
|
3. Rename the found JUnit XML files.
|
||||||
4. Merge all found JUnit XML files using :pypi:`pyEDAA.Reports` into a new JUnit XML file. |br|
|
4. Merge all found JUnit XML files using :pypi:`pyEDAA.Reports` into a new JUnit XML file. |br|
|
||||||
Optionally, apply certain transformation and cleanup operations to the JUnit report structure.
|
Optionally, apply certain transformation and cleanup operations to the JUnit report structure.
|
||||||
|
|||||||
@@ -65,7 +65,7 @@ requires a `name` parameter to create the artifact names.
|
|||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
:ref:`JOBTMPL/ExtractConfiguration`
|
:ref:`JOBTMPL/ExtractConfiguration`
|
||||||
``ExtractConfiguration`` is usualy used to compute the path to the package's source code directory.
|
``ExtractConfiguration`` is usually used to compute the path to the package's source code directory.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/CheckDocumentation/Parameters:
|
.. _JOBTMPL/CheckDocumentation/Parameters:
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
PublishReleaseNotes
|
PublishReleaseNotes
|
||||||
###################
|
###################
|
||||||
|
|
||||||
This template create a GitHub Release Page and uploads assets to that page.
|
This template creates a GitHub Release Page and uploads assets to that page.
|
||||||
|
|
||||||
.. topic:: Features
|
.. topic:: Features
|
||||||
|
|
||||||
@@ -82,12 +82,12 @@ Release Notes
|
|||||||
*************
|
*************
|
||||||
|
|
||||||
Providing a release description (a.k.a release page content) can be achieved from various sources. These sources can
|
Providing a release description (a.k.a release page content) can be achieved from various sources. These sources can
|
||||||
also be compined to a single description. Moreover, the resulting description can contain placeholders which can be
|
also be combined to a single description. Moreover, the resulting description can contain placeholders which can be
|
||||||
replaced by values provided via parameter :ref:`JOBTMPL/PublishReleaseNotes/Input/replacements`.
|
replaced by values provided via parameter :ref:`JOBTMPL/PublishReleaseNotes/Input/replacements`.
|
||||||
|
|
||||||
Description text from file in the repository
|
Description text from file in the repository
|
||||||
The job template's parameter :ref:`JOBTMPL/PublishReleaseNotes/Input/description_file` provides a way to read a
|
The job template's parameter :ref:`JOBTMPL/PublishReleaseNotes/Input/description_file` provides a way to read a
|
||||||
predfined content from a file within the repository. This allows sharing the same text between nightly releases and
|
predefined content from a file within the repository. This allows sharing the same text between nightly releases and
|
||||||
full releases.
|
full releases.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
@@ -98,16 +98,16 @@ Descriptions text from pipeline parameter
|
|||||||
The job template's parameter :ref:`JOBTMPL/PublishReleaseNotes/Input/description` provides a way to either hard code
|
The job template's parameter :ref:`JOBTMPL/PublishReleaseNotes/Input/description` provides a way to either hard code
|
||||||
a release description in YAML code, or connect a GitHub Action variable ``${{ ... }}`` to that parameter.
|
a release description in YAML code, or connect a GitHub Action variable ``${{ ... }}`` to that parameter.
|
||||||
|
|
||||||
The content is avilable in replament variable ``%%DESCRIPTION%%``.
|
The content is available in replacement variable ``%%DESCRIPTION%%``.
|
||||||
Description text from associated PullRequest
|
Description text from associated PullRequest
|
||||||
If an associated pull-request can be identified for a merge-commit, the pull-requests description can be used as a
|
If an associated pull-request can be identified for a merge-commit, the pull-requests description can be used as a
|
||||||
release description.
|
release description.
|
||||||
|
|
||||||
The content is avilable in replament variable ``%%PULLREQUEST%%``.
|
The content is available in replacement variable ``%%PULLREQUEST%%``.
|
||||||
Additional text from :ref:`JOBTMPL/PublishReleaseNotes/Input/description_footer`
|
Additional text from :ref:`JOBTMPL/PublishReleaseNotes/Input/description_footer`
|
||||||
Additionally, a footer text is provided.
|
Additionally, a footer text is provided.
|
||||||
|
|
||||||
The content is avilable in replament variable ``%%FOOTER%%``.
|
The content is available in replacement variable ``%%FOOTER%%``.
|
||||||
|
|
||||||
.. topic:: Order of Processing
|
.. topic:: Order of Processing
|
||||||
|
|
||||||
@@ -329,7 +329,7 @@ title
|
|||||||
:Required: no
|
:Required: no
|
||||||
:Default Value: ``''``
|
:Default Value: ``''``
|
||||||
:Possible Values: Any valid string suitable for a release title (headline).
|
:Possible Values: Any valid string suitable for a release title (headline).
|
||||||
:Description: If this parameter is not empty, the releases title is set, which overrides the default title infered
|
:Description: If this parameter is not empty, the releases title is set, which overrides the default title inferred
|
||||||
from the associated tag name.
|
from the associated tag name.
|
||||||
|
|
||||||
|
|
||||||
@@ -432,7 +432,7 @@ replacements
|
|||||||
:Description: The given replacements are used to replace placeholders in :ref:`JOBTMPL/PublishReleaseNotes/Input/description`,
|
:Description: The given replacements are used to replace placeholders in :ref:`JOBTMPL/PublishReleaseNotes/Input/description`,
|
||||||
:ref:`JOBTMPL/PublishReleaseNotes/Input/description_file`, :ref:`JOBTMPL/PublishReleaseNotes/Input/description_footer`. |br|
|
:ref:`JOBTMPL/PublishReleaseNotes/Input/description_file`, :ref:`JOBTMPL/PublishReleaseNotes/Input/description_footer`. |br|
|
||||||
See :ref:`JOBTMPL/PublishReleaseNotes/ReleaseNotes` for more details.
|
See :ref:`JOBTMPL/PublishReleaseNotes/ReleaseNotes` for more details.
|
||||||
:Example: The following example replaces the placeholder ``%version%`` with the actual version number (infered
|
:Example: The following example replaces the placeholder ``%version%`` with the actual version number (inferred
|
||||||
from tag name by :ref:`JOBTMPL/PrepareJob`.
|
from tag name by :ref:`JOBTMPL/PrepareJob`.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ triggers a new pipeline run for that tag, a.k.a *tag pipeline* or *release pipel
|
|||||||
* :gh:`actions/github-script`
|
* :gh:`actions/github-script`
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/PrepareJob/Instantiation:
|
.. _JOBTMPL/TagReleaseCommit/Instantiation:
|
||||||
|
|
||||||
Instantiation
|
Instantiation
|
||||||
*************
|
*************
|
||||||
|
|||||||
@@ -85,7 +85,7 @@ test (pytest) and code coverage (Coverage.py) settings.
|
|||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
:ref:`JOBTMPL/UnitTesting`
|
:ref:`JOBTMPL/UnitTesting`
|
||||||
``UnitTesting`` is usualy
|
``UnitTesting`` is usually
|
||||||
:ref:`JOBTMPL/StaticTypeCheck`
|
:ref:`JOBTMPL/StaticTypeCheck`
|
||||||
xxx
|
xxx
|
||||||
:ref:`JOBTMPL/CheckDocumentation`
|
:ref:`JOBTMPL/CheckDocumentation`
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ Parameters
|
|||||||
The ``Parameters`` job template is a workaround for the limitations of GitHub Actions to handle global variables in
|
The ``Parameters`` job template is a workaround for the limitations of GitHub Actions to handle global variables in
|
||||||
GitHub Actions workflows (see `actions/runner#480 <https://github.com/actions/runner/issues/480>`__).
|
GitHub Actions workflows (see `actions/runner#480 <https://github.com/actions/runner/issues/480>`__).
|
||||||
|
|
||||||
It generates output parameters containing a list of artifact names and a job matrix to be used in later running jobs.
|
It generates output parameters containing a list of artifact names and a job matrix to be used in later-running jobs.
|
||||||
|
|
||||||
.. topic:: Features
|
.. topic:: Features
|
||||||
|
|
||||||
@@ -239,7 +239,7 @@ name
|
|||||||
:Default Value: ``''``
|
:Default Value: ``''``
|
||||||
:Possible Values: Any valid artifact name.
|
:Possible Values: Any valid artifact name.
|
||||||
:Description: Prefix used to generate artifact names. Usually, the name of the Python package. |br|
|
:Description: Prefix used to generate artifact names. Usually, the name of the Python package. |br|
|
||||||
In case this parameter is n empty string, the artifact prefix is derived from :ref:`JOBTMPL/Parameters/Input/package_name`
|
In case this parameter is an empty string, the artifact prefix is derived from :ref:`JOBTMPL/Parameters/Input/package_name`
|
||||||
if the package is a simple Python package, **or** from :ref:`JOBTMPL/Parameters/Input/package_namespace`
|
if the package is a simple Python package, **or** from :ref:`JOBTMPL/Parameters/Input/package_namespace`
|
||||||
and :ref:`JOBTMPL/Parameters/Input/package_name`, if the package is a Python namespace package.
|
and :ref:`JOBTMPL/Parameters/Input/package_name`, if the package is a Python namespace package.
|
||||||
|
|
||||||
@@ -493,7 +493,7 @@ windows_image
|
|||||||
:Required: no
|
:Required: no
|
||||||
:Default Value: ``'windows-2025'``
|
:Default Value: ``'windows-2025'``
|
||||||
:Possible Values: See `actions/runner-images - Available Images <https://github.com/actions/runner-images?tab=readme-ov-file#available-images>`__
|
:Possible Values: See `actions/runner-images - Available Images <https://github.com/actions/runner-images?tab=readme-ov-file#available-images>`__
|
||||||
:Description: Name of the Windows Server x86-64 image and version used to run a Widnows jobs when selected via :ref:`JOBTMPL/Parameters/Input/system_list`.
|
:Description: Name of the Windows Server x86-64 image and version used to run a Windows jobs when selected via :ref:`JOBTMPL/Parameters/Input/system_list`.
|
||||||
|
|
||||||
|
|
||||||
.. _JOBTMPL/Parameters/Input/windows_arm_image:
|
.. _JOBTMPL/Parameters/Input/windows_arm_image:
|
||||||
@@ -688,7 +688,7 @@ artifact_names
|
|||||||
|
|
||||||
:Type: string (JSON)
|
:Type: string (JSON)
|
||||||
:Description: Returns a JSON dictionary of artifact names sharing a common prefix (see :ref:`JOBTMPL/Parameters/Input/name`). |br|
|
:Description: Returns a JSON dictionary of artifact names sharing a common prefix (see :ref:`JOBTMPL/Parameters/Input/name`). |br|
|
||||||
As artifacts are handed from jo to job, a consistent nameing scheme is advised to avoid duplications
|
As artifacts are handed from jo to job, a consistent naming scheme is advised to avoid duplications
|
||||||
and naming artifacts by hand. This technique solves again the problem of global variables in GitHub
|
and naming artifacts by hand. This technique solves again the problem of global variables in GitHub
|
||||||
Action YAMl files and the need for assigning the same value (here artifact name) to multiple jobs
|
Action YAMl files and the need for assigning the same value (here artifact name) to multiple jobs
|
||||||
templates.
|
templates.
|
||||||
@@ -757,4 +757,4 @@ jobs (parallel VMs) are needed to execute the matrix.
|
|||||||
.. hint::
|
.. hint::
|
||||||
|
|
||||||
Some VM images (macOS, Windows) have parallelism limitations and run slower then Ubuntu-based jobs. Additionally,
|
Some VM images (macOS, Windows) have parallelism limitations and run slower then Ubuntu-based jobs. Additionally,
|
||||||
environments like MSYS2 require an additional setup time increasing a jobs runtime segnificantly.
|
environments like MSYS2 require an additional setup time increasing a jobs runtime significantly.
|
||||||
|
|||||||
@@ -90,7 +90,7 @@ pull-request titles.
|
|||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
:ref:`JOBTMPL/TagReleaseCommit`
|
:ref:`JOBTMPL/TagReleaseCommit`
|
||||||
``PrepareJob`` is usualy used to identify if a pipeline's commit is a merge commit created by a pull-request. If
|
``PrepareJob`` is usually used to identify if a pipeline's commit is a merge commit created by a pull-request. If
|
||||||
so, this commit can be tagged automatically to trigger a release pipeline (tag pipeline) for the same commit
|
so, this commit can be tagged automatically to trigger a release pipeline (tag pipeline) for the same commit
|
||||||
resulting in a full release (PyPI, GitHub Pages, GitHub Release, ...).
|
resulting in a full release (PyPI, GitHub Pages, GitHub Release, ...).
|
||||||
:ref:`JOBTMPL/PublishReleaseNotes`
|
:ref:`JOBTMPL/PublishReleaseNotes`
|
||||||
|
|||||||
Reference in New Issue
Block a user