Files
Actions/doc/JobTemplate/CoverageCollection.rst
Patrick Lehmann c78c1c8503 Added Sphinx based documentation.
(cherry picked from commit f9f5dd5117a14ba31a3a9113a1de2c12c624dffb)
2022-10-29 22:42:09 +02:00

46 lines
761 B
ReStructuredText

CoverageCollection
##################
collect code coverage data (incl. branch coverage)
with `pytest`/`pytest-cov`/`coverage.py` using a single version of Python (latest). It generates HTML and Cobertura
(XML)reports, upload the HTML report as an artifact, and upload the test results to Codecov and Codacy. Configuration
options to `pytest` and `coverage.py` should be given via section `[tool.pytest.ini_options]` and `[tool.coverage.*]`
in a `pyproject.toml` file.
Instantiation
*************
Simple Example
==============
.. code-block:: yaml
TBD
Complex Example
===============
.. code-block:: yaml
TBD
Template Parameters
*******************
TBD 1
=====
TBD
TBD 1
=====
TBD
Template Results
****************
*None*