Added some cross references.

This commit is contained in:
Patrick Lehmann
2022-10-31 00:47:31 +01:00
parent 4a9ba5ad6f
commit 7ace9f065b
9 changed files with 84 additions and 8 deletions

View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/ArtifactCleanup:
ArtifactCleanUp
###############

View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/BuildTheDocs:
BuildTheDocs
############

View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/CodeCoverage:
CoverageCollection
##################

View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/Package:
Package
#######

View File

@@ -1,8 +1,10 @@
.. _JOBTMPL/Parameters:
Parameters
##########
The `Parameters` job template is a workaround for the limitations of GitHub Actions to handle global variables in
GitHub Actions workflows (see [actions/runner#480](https://github.com/actions/runner/issues/480)).
The ``Parameters`` job template is a workaround for the limitations of GitHub Actions to handle global variables in
GitHub Actions workflows (see `actions/runner#480 <https://github.com/actions/runner/issues/480>`__.
It generates output parameters with artifact names and a job matrix to be used in later running jobs.

View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/PyPI:
PublishOnPyPI
#############

View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/UnitTesting:
UnitTesting
###########
@@ -67,11 +69,11 @@ requirements
Python dependencies to be installed through pip.
+----------+----------+----------+
| Required | Type | Default |
+==========+==========+==========+
+----------+----------+---------------------------------+
| Required | Type | Default |
+==========+==========+=================================+
| optional | string | ``-r tests/requirements.txt`` |
+----------+----------+----------+
+----------+----------+---------------------------------+
pacboy

View File

@@ -1,4 +1,32 @@
Overview
########
**Global Templates**
* :ref:`JOBTMPL/Parameters`
**Unit Tests, Code Coverage, ...**
* :ref:`JOBTMPL/UnitTesting`
* :ref:`JOBTMPL/CodeCoverage`
* Static type checking
**Build and Packaging**
* :ref:`JOBTMPL/Package`
**Documentation**
* Verify docs
* :ref:`JOBTMPL/BuildTheDocs`
**Publishing**
* :ref:`JOBTMPL/GitHubReleasePage`
* :ref:`JOBTMPL/PyPI`
* Publish test results
* Publish to github pages
**Cleanups**
* :ref:`JOBTMPL/ArtifactCleanup`