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

Updated documentation.

Browse Source
This commit is contained in:
Patrick Lehmann
2022-11-05 22:18:02 +01:00
parent 439290c700
commit 69d566d369
1 changed files with 30 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/JobTemplate/Parameters.rst
View File

@@ -345,14 +345,39 @@ A dictionary of artifact names sharing a common prefix.
The supported artifacts are: The supported artifacts are:
* ``unittesting`` - UnitTesting XML summary report * ``unittesting_xml`` - UnitTesting XML summary report
* ``codecoverage`` - Code Coverage HTML report * ``codecoverage_xml`` - Code Coverage XML report
* ``statictyping`` - Static Type Checking HTML report * ``codecoverage_html`` - Code Coverage HTML report
* ``package`` - Packaged Python project * ``statictyping_html`` - Static Type Checking HTML report
* ``documentation`` - Documentation in HTML format * ``package_all`` - Packaged Python project (multiple formats)
* ``documentation_pdf`` - Documentation in PDF format
* ``documentation_html`` - Documentation in HTML format
**Usage Example:**
.. code-block:: yaml
jobs:
Params:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
with:
name: pyTooling
Coverage:
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@dev
needs:
- Params
with:
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
Params Params
====== ======
.. attention:: ``Params`` is deprecated. .. attention:: ``Params`` is deprecated.
* ``params['unittesting']`` |rarr| ``artifact_names['unittesting_xml']``
* ``params['coverage']`` |rarr| ``artifact_names['codecoverage_xml']``
* ``params['typing']`` |rarr| ``artifact_names['statictyping_html']``
* ``params['package']`` |rarr| ``artifact_names['package_all']``
* ``params['doc']`` |rarr| ``artifact_names['documentation_html']``