pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-12 11:06:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

General documentation refinements.

Browse Source
This commit is contained in:
Patrick Lehmann
2022-11-02 01:53:57 +01:00
parent be1eaa4de4
commit 4aa82d16d3
15 changed files with 367 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
doc/JobTemplate/UnitTesting.rst
View File

@@ -56,36 +56,37 @@ Parameters
jobs
====
+----------------+----------+----------+--------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+==============+
| jobs | yes | string | — — — — |
+----------------+----------+----------+--------------+
JSON list with environment fields, telling the system and Python versions to run tests with.
+----------+----------+--------------+
| Required | Type | Default |
+==========+==========+==============+
| yes | string | — — — — |
+----------+----------+--------------+
requirements
============
Python dependencies to be installed through pip.
+----------------+----------+----------+---------------------------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+=================================+
| requirements | optional | string | ``-r tests/requirements.txt`` |
+----------------+----------+----------+---------------------------------+
+----------+----------+---------------------------------+
| Required | Type | Default |
+==========+==========+=================================+
| optional | string | ``-r tests/requirements.txt`` |
+----------+----------+---------------------------------+
Python dependencies to be installed through pip.
pacboy
======
MSYS2 dependencies to be installed through pacboy (pacman).
+----------------+----------+----------+-----------------------------------------------------------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+=================================================================+
| pacboy | optional | string | ``python-pip:p python-wheel:p python-coverage:p python-lxml:p`` |
+----------------+----------+----------+-----------------------------------------------------------------+
+----------+----------+-----------------------------------------------------------------+
| Required | Type | Default |
+==========+==========+=================================================================+
| optional | string | ``python-pip:p python-wheel:p python-coverage:p python-lxml:p`` |
+----------+----------+-----------------------------------------------------------------+
MSYS2 dependencies to be installed through pacboy (pacman).
.. code-block:: yaml
@@ -99,49 +100,49 @@ MSYS2 dependencies to be installed through pacboy (pacman).
mingw_requirements
==================
Override Python dependencies to be installed through pip on MSYS2 (MINGW64) only.
+--------------------+----------+----------+----------+
| Parameter Name | Required | Type | Default |
+====================+==========+==========+==========+
| mingw_requirements | optional | string | ``""`` |
+--------------------+----------+----------+----------+
+----------+----------+----------+
| Required | Type | Default |
+==========+==========+==========+
| optional | string | ``""`` |
+----------+----------+----------+
Override Python dependencies to be installed through pip on MSYS2 (MINGW64) only.
tests_directory
===============
Path to the directory containing tests (test working directory).
+-----------------+----------+----------+-----------+
| Parameter Name | Required | Type | Default |
+=================+==========+==========+===========+
| tests_directory | optional | string | ``tests`` |
+-----------------+----------+----------+-----------+
+----------+----------+-----------+
| Required | Type | Default |
+==========+==========+===========+
| optional | string | ``tests`` |
+----------+----------+-----------+
Path to the directory containing tests (test working directory).
unittest_directory
==================
Path to the directory containing unit tests (relative to tests_directory).
+--------------------+----------+----------+----------+
| Parameter Name | Required | Type | Default |
+====================+==========+==========+==========+
| unittest_directory | optional | string | ``unit`` |
+--------------------+----------+----------+----------+
+----------+----------+----------+
| Required | Type | Default |
+==========+==========+==========+
| optional | string | ``unit`` |
+----------+----------+----------+
Path to the directory containing unit tests (relative to tests_directory).
artifact
========
Generate unit test report with junitxml and upload results as an artifact.
+----------------+----------+----------+----------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+==========+
| artifact | optional | string | ``""`` |
+----------------+----------+----------+----------+
+----------+----------+----------+
| Required | Type | Default |
+==========+==========+==========+
| optional | string | ``""`` |
+----------+----------+----------+
Generate unit test report with junitxml and upload results as an artifact.
Secrets
@@ -149,6 +150,7 @@ Secrets
This job template needs no secrets.
Results
*******