mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Document all recently added workflow templates.
This commit is contained in:
40
doc/JobTemplate/AllInOne/CompletePipeline.rst
Normal file
40
doc/JobTemplate/AllInOne/CompletePipeline.rst
Normal file
@@ -0,0 +1,40 @@
|
||||
.. _JOBTMPL/CompletePipeline:
|
||||
|
||||
CompletePipeline
|
||||
################
|
||||
|
||||
The ``CompletePipeline`` 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.
|
||||
|
||||
**Behavior:**
|
||||
|
||||
.. todo:: Parameters:Behavior Needs documentation.
|
||||
|
||||
**Dependencies:**
|
||||
|
||||
*None*
|
||||
|
||||
Instantiation
|
||||
*************
|
||||
|
||||
Simple Example
|
||||
==============
|
||||
|
||||
The following instantiation example creates a job `Params` derived from job template `Parameters` version `r0`. It only
|
||||
requires a `name` parameter to create the artifact names.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
name: Pipeline
|
||||
|
||||
on:
|
||||
push:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
Params:
|
||||
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r0
|
||||
with:
|
||||
name: pyTooling
|
||||
32
doc/JobTemplate/AllInOne/index.rst
Normal file
32
doc/JobTemplate/AllInOne/index.rst
Normal file
@@ -0,0 +1,32 @@
|
||||
.. _JOBTMPL/AllInOne:
|
||||
|
||||
All-In-One
|
||||
##########
|
||||
|
||||
The category *all-in-one* provides workflow templates implementing all necessary steps (jobs) for testing and publishing
|
||||
a Python project. It utilizes allmost all of ``pyTooling/Acion``'s workflow templates.
|
||||
|
||||
Such a all-in-one workflow template covers:
|
||||
|
||||
* unit testing
|
||||
* code coverage collections
|
||||
* documentation checking
|
||||
* pulishing of unit test and code coverage results
|
||||
* merging of test reports
|
||||
* packaging as wheel
|
||||
* publishing wheels tp PyPI
|
||||
* documentation generation via Sphinx and Miktex
|
||||
* automatic tagging of release commits
|
||||
* releasing
|
||||
|
||||
.. topic:: Provides *all-in-one* workflow templates
|
||||
|
||||
* :ref:`JOBTMPL/CompletePipeline` - Use all of ``pyTooling/Acion``'s workflow templates by instantiation of a single
|
||||
workflow template.
|
||||
|
||||
.. image:: ../../_static/pyTooling-Actions-SimplePackage.png
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
CompletePipeline
|
||||
Reference in New Issue
Block a user