This commit is contained in:
Patrick Lehmann
2025-01-14 17:39:43 +01:00
45 changed files with 672 additions and 433 deletions

View File

@@ -95,7 +95,7 @@ The following block shows a minimal YAML workflow file:
# Update tag and pre-release
# - Update (force-push) tag to the commit that is used in the workflow.
# - Upload artifacts defined by the user.
- uses: pyTooling/Actions/releaser@r0
- uses: pyTooling/Actions/releaser@r4
with:
token: ${{ secrets.GITHUB_TOKEN }}
files: |

View File

@@ -60,12 +60,12 @@ Documentation Only (Sphinx)
jobs:
BuildTheDocs:
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r4
with:
artifact: Documentation
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r4
needs:
- BuildTheDocs
with:

View File

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

View File

@@ -30,7 +30,7 @@ Simple Example
jobs:
BuildTheDocs:
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r4
Complex Example
@@ -40,7 +40,7 @@ Complex Example
jobs:
BuildTheDocs:
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r4
needs:
- Params
with:

View File

@@ -52,7 +52,7 @@ Simple Example
jobs:
Coverage:
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r0
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r4
with:
artifact: Coverage
secrets:
@@ -65,7 +65,7 @@ Complex Example
jobs:
Coverage:
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r0
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r4
needs:
- Params
with:

View File

@@ -33,7 +33,7 @@ Simple Example
jobs:
Package:
uses: pyTooling/Actions/.github/workflows/Package.yml@r0
uses: pyTooling/Actions/.github/workflows/Package.yml@r4
with:
artifact: Package
@@ -45,7 +45,7 @@ Complex Example
jobs:
Package:
uses: pyTooling/Actions/.github/workflows/Package.yml@r0
uses: pyTooling/Actions/.github/workflows/Package.yml@r4
needs:
- Params
- Coverage

View File

@@ -35,7 +35,7 @@ requires a `name` parameter to create the artifact names.
jobs:
Params:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
with:
name: pyTooling
@@ -81,7 +81,7 @@ over resulting in the following combinations:
jobs:
UnitTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
with:
name: pyTooling
python_version_list: "3.8 3.9 3.10 3.11 pypy-3.9 pypy-3.10"
@@ -89,14 +89,14 @@ over resulting in the following combinations:
exclude_list: "windows:pypy-3.9 windows:pypy-3.10"
PerformanceTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
with:
name: pyTooling
python_version_list: "3.11 3.12"
system_list: "ubuntu windows macos"
PlatformTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
with:
name: pyTooling
python_version_list: "3.12"
@@ -297,12 +297,12 @@ variables. Thus, this job is used to compute an output parameter that can be reu
jobs:
Params:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
with:
name: pyTooling
CodeCoverage:
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r0
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r4
needs:
- Params
with:
@@ -330,12 +330,12 @@ A job description contains the following key-value pairs:
jobs:
Params:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
with:
name: pyTooling
UnitTesting:
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r4
needs:
- Params
with:
@@ -389,12 +389,12 @@ The supported artifacts are:
jobs:
Params:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
with:
name: pyTooling
Coverage:
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@dev
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r4
needs:
- Params
with:

View File

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

View File

@@ -34,7 +34,7 @@ Simple Example
jobs:
PublishTestResults:
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r0
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r4
Complex Example
===============
@@ -49,7 +49,7 @@ Complex Example
# ...
PublishTestResults:
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r0
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r4
needs:
- CodeCoverage
- UnitTesting

View File

@@ -29,7 +29,7 @@ Simple Example
# ...
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r4
needs:
- BuildTheDocs
with:
@@ -43,7 +43,7 @@ Complex Example
jobs:
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r4
needs:
- Params
- BuildTheDocs

View File

@@ -62,7 +62,7 @@ Simple Example
jobs:
Release:
uses: pyTooling/Actions/.github/workflows/Release.yml@r0
uses: pyTooling/Actions/.github/workflows/Release.yml@r4
Complex Example
@@ -72,7 +72,7 @@ Complex Example
jobs:
Release:
uses: pyTooling/Actions/.github/workflows/Release.yml@r0
uses: pyTooling/Actions/.github/workflows/Release.yml@r4
if: startsWith(github.ref, 'refs/tags')
needs:
- Package

View File

@@ -29,7 +29,7 @@ Simple Example
jobs:
StaticTypeCheck:
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r0
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r4
with:
commands: |
touch pyTooling/__init__.py
@@ -44,7 +44,7 @@ Complex Example
jobs:
StaticTypeCheck:
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r0
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r4
needs:
- Params
with:

View File

@@ -36,7 +36,7 @@ Simple Example
# ...
UnitTesting:
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r0
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r4
needs:
- Params
with:

Binary file not shown.

After

Width:  |  Height:  |  Size: 555 KiB

View File

@@ -11,7 +11,7 @@ docutils_stubs ~= 0.0.22
sphinx_rtd_theme ~= 3.0
# Sphinx Extenstions
sphinxcontrib-mermaid>=0.9.2
sphinxcontrib-mermaid ~= 1.0
autoapi >= 2.0.1
sphinx_design ~= 0.6.1
sphinx-copybutton >= 0.5.2

View File

@@ -4,11 +4,11 @@
# percent encoding so that the URL is properly parsed.
.. # Sourcecode link to GitHub
.. |SHIELD:svg:pyTooling-github| image:: https://img.shields.io/badge/pyTooling-Actions-63bf7f.svg?longCache=true&style=flat-square&longCache=true&logo=GitHub
.. |SHIELD:svg:pyTooling-github| image:: https://img.shields.io/badge/pyTooling-Actions-63bf7f?longCache=true&style=flat-square&longCache=true&logo=GitHub
:alt: Sourcecode on GitHub
:height: 22
:target: https://GitHub.com/pyTooling/Actions
.. |SHIELD:png:pyTooling-github| image:: https://raster.shields.io/badge/pyTooling-Actions-63bf7f.svg?longCache=true&style=flat-square&longCache=true&logo=GitHub
.. |SHIELD:png:pyTooling-github| image:: https://raster.shields.io/badge/pyTooling-Actions-63bf7f?longCache=true&style=flat-square&longCache=true&logo=GitHub
:alt: Sourcecode on GitHub
:height: 22
:target: https://GitHub.com/pyTooling/Actions
@@ -18,7 +18,7 @@
:alt: Code license
:height: 22
:target: Code-License.html
.. |SHIELD:png:pyTooling-src-license| image:: https://img.shields.io/pypi/l/pyTooling?longCache=true&style=flat-square&logo=Apache&label=code
.. |SHIELD:png:pyTooling-src-license| image:: https://raster.shields.io/pypi/l/pyTooling?longCache=true&style=flat-square&logo=Apache&label=code
:alt: Code license
:height: 22
:target: https://GitHub.com/pyTooling/Actions/blob/main/LICENSE.md
@@ -64,11 +64,11 @@
:target: https://pyTooling.github.io/pyTooling/
.. # Gitter
.. |SHIELD:svg:pyTooling-gitter| image:: https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef
.. |SHIELD:svg:pyTooling-gitter| image:: https://img.shields.io/badge/chat-on%20gitter-4db797.?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef
:alt: Documentation License
:height: 22
:target: https://gitter.im/hdl/community
.. |SHIELD:png:pyTooling-gitter| image:: https://raster.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef
.. |SHIELD:png:pyTooling-gitter| image:: https://raster.shields.io/badge/chat-on%20gitter-4db797.?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef
:alt: Documentation License
:height: 22
:target: https://gitter.im/hdl/community