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

Improved links.

Browse Source
This commit is contained in:
Patrick Lehmann
2025-09-24 15:17:57 +02:00
parent c0547188f9
commit a8e4c60424
6 changed files with 21 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -781,7 +781,7 @@ PYPI_TOKEN
:Type: string
:Required: no
:Default Value: — — — —
:Description: The token to publish and upload packages on `PyPI <https://pypi.org/>`__.
:Description: The token to publish and upload packages on :term:`PyPI`.
.. _JOBTMPL/CompletePipeline/Secret/CODECOV_TOKEN:
@@ -792,7 +792,7 @@ CODECOV_TOKEN
:Type: string
:Required: no
:Default Value: — — — —
:Description: The token to publish code coverage and unit test results to `CodeCov <https://about.codecov.io//>`__.
:Description: The token to publish code coverage and unit test results to :term:`CodeCov`.
.. _JOBTMPL/CompletePipeline/Secret/CODACY_TOKEN:
@@ -803,7 +803,7 @@ CODACY_TOKEN
:Type: string
:Required: no
:Default Value: — — — —
:Description: The token to publish code coverage results to `Codacy <https://www.codacy.com/>`__.
:Description: The token to publish code coverage results to :term:`Codacy`.
.. _JOBTMPL/CompletePipeline/Outputs:

3
doc/JobTemplate/Package/InstallPackage.rst
View File

@@ -12,12 +12,13 @@ the installation is verified. This aims for packaging and dependency mistakes in
.. topic:: Features
* Install generated Python package on the target platform.
* Verify the installed package's version.
.. topic:: Behavior
* Download Python package as artifact.
* Prepare the Python environment.
* Install the Python package using ``pip``.
* Install the Python package using :term:`pip`.
* Read out and verify the package version.
.. topic:: Job Execution

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

@@ -7,11 +7,11 @@
PublishOnPyPI
#############
Publish a wheel (``*.whl``) packages and/or source (``*.tar.gz``) package to `PyPI <https://pypi.org/>`__.
Publish a wheel (``*.whl``) packages and/or source (``*.tar.gz``) package to :term:`PyPI`.
.. topic:: Features
* Publish a Python package to `PyPI <https://pypi.org/>`__.
* Publish a Python package to :term:`PyPI`.
.. topic:: Behavior
@@ -191,7 +191,7 @@ PYPI_TOKEN
:Type: string
:Required: no
:Default Value: — — — —
:Description: The token to publish and upload packages on `PyPI <https://pypi.org/>`__.
:Description: The token to publish and upload packages on :term:`PyPI`.
.. _JOBTMPL/PublishOnPyPI/Outputs:

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

@@ -424,7 +424,7 @@ CODECOV_TOKEN
:Type: string
:Required: no
:Default Value: — — — —
:Description: The token to publish code coverage and unit test results to `CodeCov <https://about.codecov.io//>`__.
:Description: The token to publish code coverage and unit test results to :term:`CodeCov`.
.. _JOBTMPL/PublishCoverageResults/Secret/CODACY_TOKEN:
@@ -435,7 +435,7 @@ CODACY_TOKEN
:Type: string
:Required: no
:Default Value: — — — —
:Description: The token to publish code coverage results to `Codacy <https://www.codacy.com/>`__.
:Description: The token to publish code coverage results to :term:`Codacy`.

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

@@ -13,8 +13,8 @@ JUnit test summary reports to multiple services for visualization and longterm s
Supported services are:
* GitHub Actions job results using :gh:`dorny/test-reporter`
* `Codecov <https://about.codecov.io/>`__
* GitHub Actions job results using :term:`Test Reporter`
* :term:`Codecov`
.. topic:: Features
@@ -29,10 +29,10 @@ Supported services are:
pattern (see :ref:`JOBTMPL/PublishTestResults/Input/unittest_artifacts_pattern`) for limiting the number of
downloaded artifacts and the hereby generated traffic.
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 :term:`pyEDAA.Reports` into a new JUnit XML file. |br|
Optionally, apply certain transformation and cleanup operations to the JUnit report structure.
5. Publish test results as a markdown report page to GitHub Actions using :gh:`dorny/test-reporter`.
6. Publish test results to `Codecov <https://about.codecov.io/>`__ using :gh:`codecov/test-results-action`.
5. Publish test results as a markdown report page to GitHub Actions using :term:`Test Reporter`.
6. Publish test results to :term:`Codecov` using :gh:`codecov/test-results-action`.
.. topic:: Job Execution
@@ -325,7 +325,7 @@ CODECOV_TOKEN
:Type: string
:Required: no
:Default Value: — — — —
:Description: The token to publish unit test results on `Codecov <https://about.codecov.io/>`__.
:Description: The token to publish unit test results on :term:`CodeCov`.
.. _JOBTMPL/PublishTestResults/Outputs:

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

@@ -10,16 +10,16 @@ UnitTesting
This template runs multiple jobs from a matrix as a cross of Python versions and systems. The summary report in junit
XML format is optionally uploaded as an artifact.
Configuration options to ``pytest`` should be given via section ``[tool.pytest.ini_options]`` in a ``pyproject.toml``
file.
Configuration options to :term:`pytest` should be given via section ``[tool.pytest.ini_options]`` in a
``pyproject.toml`` file.
.. topic:: Features
* Execute unit tests using `pytest <https://docs.pytest.org/en/stable/>`__.
* Execute unit tests using :term:`pytest`.
* Provide unit test results as JUnit XML file (pyTest XML dialect).
* Collect code coverage using `Coverage.py <https://coverage.readthedocs.io/>`__.
* Collect code coverage using :term:`Coverage.py`.
* Provide code coverage results as pytest SQLite database.
* Provide code coverage results as Cobertura XML file.
@@ -30,7 +30,7 @@ file.
1. Checkout repository.
2. Setup environment and install dependencies (``apt``, ``homebrew``, ``pacman``, ...).
3. Setup Python and install dependencies (``pip``).
3. Setup Python and install dependencies (:term:`pip`).
4. Run instructions from ``*_before_script`` parameter.
5. Run unit tests using *pytest* and if enabled in combination with *Coverage.py*.
6. Convert gathered results to other formats.