mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 11:06:56 +08:00
Added some cross references.
This commit is contained in:
@@ -1,3 +1,5 @@
|
||||
.. _JOBTMPL/ArtifactCleanup:
|
||||
|
||||
ArtifactCleanUp
|
||||
###############
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _JOBTMPL/BuildTheDocs:
|
||||
|
||||
BuildTheDocs
|
||||
############
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _JOBTMPL/CodeCoverage:
|
||||
|
||||
CoverageCollection
|
||||
##################
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _JOBTMPL/Package:
|
||||
|
||||
Package
|
||||
#######
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _JOBTMPL/PyPI:
|
||||
|
||||
PublishOnPyPI
|
||||
#############
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -36,8 +36,42 @@ Introduction
|
||||
|
||||
|
||||
|
||||
Package Details
|
||||
***************
|
||||
GitHub Action Job Templates
|
||||
***************************
|
||||
|
||||
**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`
|
||||
|
||||
|
||||
GitHub Actions
|
||||
**************
|
||||
|
||||
|
||||
Contributors
|
||||
|
||||
Reference in New Issue
Block a user