Files
Actions/doc/JobTemplate/StaticTypeCheck.rst
2022-10-30 18:14:36 +01:00

73 lines
878 B
ReStructuredText

StaticTypeCheck
###############
collect static type check result with mypy, and optionally upload results as an HTML report.
Example ``commands``:
1. Regular package
.. code-block:: yaml
commands: mypy --html-report htmlmypy -p ToolName
2. Parent namespace package
.. code-block:: yaml
commands: |
touch Parent/__init__.py
mypy --html-report htmlmypy -p ToolName
3. Child namespace package
.. code-block:: yaml
commands: |
cd Parent
mypy --html-report ../htmlmypy -p ToolName
Instantiation
*************
Simple Example
==============
.. code-block:: yaml
TBD
Complex Example
===============
.. code-block:: yaml
TBD
Parameters
**********
TBD 1
=====
TBD
TBD 1
=====
TBD
Secrets
*******
This job template needs no secrets.
Results
*******
This job template has no output parameters.