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

Added more documentation sections.

Browse Source
This commit is contained in:
Patrick Lehmann
2022-10-30 18:14:36 +01:00
parent 8d21ca154d
commit d7ad8f1387
6 changed files with 233 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/JobTemplate/CoverageCollection.rst
View File

@@ -18,8 +18,9 @@ Configuration options to ``pytest`` and ``coverage.py`` should be given via sect
4. Run unit tests and collect code coverage
5. Convert coverage data to a Cobertura XML file
6. Convert coverage data to a HTML report
7. Publish Cobertura file to CodeCov
8. Publish Cobertura file to Codacy
7. Upload HTML report as an artifact
8. Publish Cobertura file to CodeCov
9. Publish Cobertura file to Codacy
**Preconditions:**
@@ -30,6 +31,14 @@ Configuration options to ``pytest`` and ``coverage.py`` should be given via sect
Setup a secret (e.g. ``codacy_token``) in GitHub to handover the Codacy project token to the job.
**Dependencies:**
* actions/checkout@v2
* actions/setup-python@v2
* actions/upload-artifact@v2
* codecov/codecov-action@v1
* codacy/codacy-coverage-reporter-action@master
Instantiation
*************
@@ -63,8 +72,8 @@ Complex Example
secrets:
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
Template Parameters
*******************
Parameters
**********
python_version
==============
@@ -152,7 +161,7 @@ Token to push result to codacy.
+----------+----------+--------------+
Template Results
****************
Results
*******
*None*
This job template has no output parameters.