mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
183 lines
4.5 KiB
ReStructuredText
183 lines
4.5 KiB
ReStructuredText
.. _JOBTMPL/StaticTypeChecking:
|
|
|
|
StaticTypeCheck
|
|
###############
|
|
|
|
This job runs a static type check using mypy and collects the results. These results can be converted to a HTML report
|
|
and then uploaded as an artifact.
|
|
|
|
**Behavior:**
|
|
|
|
1. Checkout repository
|
|
2. Setup Python and install dependencies
|
|
3. Run type checking command(s).
|
|
4. Upload type checking report as an artifact
|
|
|
|
**Dependencies:**
|
|
|
|
* :gh:`actions/checkout`
|
|
* :gh:`actions/setup-python`
|
|
* :gh:`actions/upload-artifact`
|
|
|
|
Instantiation
|
|
*************
|
|
|
|
Simple Example
|
|
==============
|
|
|
|
.. code-block:: yaml
|
|
|
|
jobs:
|
|
StaticTypeCheck:
|
|
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r0
|
|
with:
|
|
commands: |
|
|
touch pyTooling/__init__.py
|
|
mypy --html-report htmlmypy -p pyTooling
|
|
report: 'htmlmypy'
|
|
artifact: TypeChecking
|
|
|
|
Complex Example
|
|
===============
|
|
|
|
.. code-block:: yaml
|
|
|
|
jobs:
|
|
StaticTypeCheck:
|
|
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r0
|
|
needs:
|
|
- Params
|
|
with:
|
|
python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
|
|
commands: |
|
|
touch pyTooling/__init__.py
|
|
mypy --html-report htmlmypy -p pyTooling
|
|
report: 'htmlmypy'
|
|
artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
|
|
|
|
Commands
|
|
========
|
|
|
|
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
|
|
|
|
Parameters
|
|
**********
|
|
|
|
python_version
|
|
==============
|
|
|
|
+----------------+----------+----------+-----------------+
|
|
| Parameter Name | Required | Type | Default |
|
|
+================+==========+==========+=================+
|
|
| python_version | optional | string | ``3.11`` |
|
|
+----------------+----------+----------+-----------------+
|
|
|
|
Python version.
|
|
|
|
|
|
requirements
|
|
============
|
|
|
|
+----------------+----------+----------+-------------------------------+
|
|
| Parameter Name | Required | Type | Default |
|
|
+================+==========+==========+===============================+
|
|
| requirements | optional | string | ``-r tests/requirements.txt`` |
|
|
+----------------+----------+----------+-------------------------------+
|
|
|
|
Python dependencies to be installed through pip.
|
|
|
|
|
|
commands
|
|
========
|
|
|
|
+----------------+----------+----------+--------------+
|
|
| Parameter Name | Required | Type | Default |
|
|
+================+==========+==========+==============+
|
|
| commands | yes | string | — — — — |
|
|
+----------------+----------+----------+--------------+
|
|
|
|
Commands to run the static type checks.
|
|
|
|
|
|
html_report
|
|
===========
|
|
|
|
+----------------+----------+----------+-----------------+
|
|
| Parameter Name | Required | Type | Default |
|
|
+================+==========+==========+=================+
|
|
| report | optional | string | ``htmlmypy`` |
|
|
+----------------+----------+----------+-----------------+
|
|
|
|
HTML output directory to upload as an artifact.
|
|
|
|
|
|
junit_report
|
|
============
|
|
|
|
+----------------+----------+----------+-----------------------------+
|
|
| Parameter Name | Required | Type | Default |
|
|
+================+==========+==========+=============================+
|
|
| report | optional | string | ``StaticTypingSummary.xml`` |
|
|
+----------------+----------+----------+-----------------------------+
|
|
|
|
junit file to upload as an artifact.
|
|
|
|
|
|
html_artifact
|
|
=============
|
|
|
|
+----------------+----------+----------+--------------+
|
|
| Parameter Name | Required | Type | Default |
|
|
+================+==========+==========+==============+
|
|
| html_artifact | yes | string | — — — — |
|
|
+----------------+----------+----------+--------------+
|
|
|
|
Name of the typing artifact.
|
|
|
|
|
|
junit_artifact
|
|
==============
|
|
|
|
+----------------+----------+----------+--------------+
|
|
| Parameter Name | Required | Type | Default |
|
|
+================+==========+==========+==============+
|
|
| junit_artifact | optional | string | ``""`` |
|
|
+----------------+----------+----------+--------------+
|
|
|
|
Name of the typing artifact.
|
|
|
|
|
|
Secrets
|
|
*******
|
|
|
|
This job template needs no secrets.
|
|
|
|
|
|
Results
|
|
*******
|
|
|
|
This job template has no output parameters.
|