pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-17 05:26: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

35
doc/JobTemplate/PublishToGitHubPages.rst
View File

@@ -54,42 +54,45 @@ Complex Example
coverage: ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
typing: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
Parameters
**********
doc
===
+----------------+----------+----------+--------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+==============+
| doc | yes | string | — — — — |
+----------------+----------+----------+--------------+
Name of the documentation artifact.
+----------+----------+--------------+
| Required | Type | Default |
+==========+==========+==============+
| yes | string | — — — — |
+----------+----------+--------------+
coverage
========
Name of the coverage artifact.
+----------------+----------+----------+-----------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+=================+
| coverage | optional | string | ``""`` |
+----------------+----------+----------+-----------------+
+----------+----------+-----------------+
| Required | Type | Default |
+==========+==========+=================+
| optional | string | ``""`` |
+----------+----------+-----------------+
Name of the coverage artifact.
typing
======
+----------------+----------+----------+-----------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+=================+
| typing | optional | string | ``""`` |
+----------------+----------+----------+-----------------+
Name of the typing artifact.
+----------+----------+-----------------+
| Required | Type | Default |
+==========+==========+=================+
| optional | string | ``""`` |
+----------+----------+-----------------+
Secrets