Actions/doc/index.rst

.. include:: shields.inc

.. raw:: latex

   \part{Introduction}

.. only:: html

   |  |SHIELD:svg:pyTooling-github| |SHIELD:svg:pyTooling-src-license| |SHIELD:svg:pyTooling-ghp-doc| |SHIELD:svg:pyTooling-doc-license|
   |  |SHIELD:svg:pyTooling-tag| |SHIELD:svg:pyTooling-date|

.. Disabled shields: |SHIELD:svg:pyTooling-gitter|

.. only:: latex

   |SHIELD:png:pyTooling-github| |SHIELD:png:pyTooling-src-license| |SHIELD:png:pyTooling-ghp-doc| |SHIELD:png:pyTooling-doc-license|
   |SHIELD:png:pyTooling-tag| |SHIELD:png:pyTooling-date|

.. Disabled shields: |SHIELD:svg:pyTooling-gitter|

--------------------------------------------------------------------------------

pyTooling Actions Documentation
###############################

**pyTooling Actions** are reusable steps and workflows for GitHub Actions easing the creation and maintenance of
workflows for Python projects on GitHub.

Introduction
************

GitHub Actions workflows, actions and documentation are mostly focused on JavaScript/TypeScript as the scripting
language for writing reusable CI code.
However, Python being equally popular and capable, usage of JS/TS might be bypassed, with some caveats.
This repository gathers reusable CI tooling for testing, packaging and distributing Python projects and documentation.


GitHub Action Job Templates
***************************

The following list categorizes all pre-defined job templates, which can be instantiated in a pipeline (GitHub Action
Workflow):

.. grid:: 5

   .. grid-item::
      :columns: 2

      .. rubric:: All-In-One Templates

      * :ref:`JOBTMPL/CompletePipeline`

      .. rubric:: Global Templates

      * :ref:`JOBTMPL/Parameters`
      * :ref:`JOBTMPL/PrepareJob`
      * :ref:`JOBTMPL/ExtractConfiguration`

   .. grid-item::
      :columns: 2

      .. rubric:: Documentation

      * :ref:`JOBTMPL/CheckDocumentation`
      * :ref:`JOBTMPL/VerifyDocs`
      * :ref:`JOBTMPL/SphinxDocumentation`
      * :ref:`JOBTMPL/LaTeXDocumentation`

      .. rubric:: Unit Tests, Code Coverage

      * :ref:`JOBTMPL/ApplicationTesting`
      * :ref:`JOBTMPL/UnitTesting`

   .. grid-item::
      :columns: 2

      .. rubric:: Code Quality

      * :ref:`JOBTMPL/StaticTypeChecking`
      * *code formatting (planned)*
      * *coding style (planned)*
      * *code linting (planned)*

      .. rubric:: Build and Packaging

      * :ref:`JOBTMPL/Package`
      * :ref:`JOBTMPL/InstallPackage`

   .. grid-item::
      :columns: 2

      .. rubric:: Publishing

      * :ref:`JOBTMPL/PublishOnPyPI`
      * :ref:`JOBTMPL/PublishTestResults`
      * :ref:`JOBTMPL/PublishCoverageResults`
      * :ref:`JOBTMPL/PublishToGitHubPages`

      .. rubric:: Releasing

      * :ref:`JOBTMPL/PublishReleaseNotes`
      * :ref:`JOBTMPL/TagReleaseCommit`

   .. grid-item::
      :columns: 2

      .. rubric:: Cleanup Templates

      * :ref:`JOBTMPL/IntermediateCleanup`
      * :ref:`JOBTMPL/ArtifactCleanup`

   .. grid-item::
      :columns: 2

      .. rubric:: :ref:`JOBTMPL/Deprecated`

      * :ref:`JOBTMPL/CodeCoverage`
      * :ref:`JOBTMPL/NightlyRelease`
      * :ref:`JOBTMPL/BuildTheDocs`


Example Pipelines
=================

``ExamplePipeline.yml`` is an example Workflow which uses all of the Reusable Workflows.
Python package/tool developers can copy it into their repos, in order to use al the reusable workflows straightaway.
Minimal required modifications are the following:

- Set the ``name`` input of job ``Parameters``.
- Specify the ``commands`` input of job ``StaticTypeCheck``.


GitHub Actions
**************

* :ref:`ACTION/Releaser`
* :ref:`ACTION/WithPostStep`

References
**********

- `hdl/containers#48 <https://github.com/hdl/containers/issues/48>`__


.. _CONTRIBUTORS:

Contributors
************

* `Patrick Lehmann <https://GitHub.com/Paebbels>`__
* `Unai Martinez-Corral <https://GitHub.com/umarcor>`__ (Maintainer)
* `and more... <https://GitHub.com/pyTooling/Actions/graphs/contributors>`__


.. _LICENSE:

License
*******

.. only:: html

   This Python package (source code) is licensed under `Apache License 2.0 <Code-License.html>`__. |br|
   The accompanying documentation is licensed under `Creative Commons - Attribution 4.0 (CC-BY 4.0) <Doc-License.html>`__.

.. only:: latex

   This Python package (source code) is licensed under **Apache License 2.0**. |br|
   The accompanying documentation is licensed under **Creative Commons - Attribution 4.0 (CC-BY 4.0)**.


.. toctree::
   :caption: Introduction
   :hidden:

   Background
   RepositoryStructure
   Instantiation
   Deveopment
   Dependency
   Releases

.. raw:: latex

   \part{Main Documentation}

.. toctree::
   :caption: Actions
   :hidden:

   Action/index
   Action/Releaser
   Action/With-post-step

.. toctree::
   :caption: Job Templates
   :hidden:

   JobTemplate/index
   JobTemplate/AllInOne/index
   JobTemplate/Global/index
   JobTemplate/Documentation/index
   JobTemplate/UnitTesting
   JobTemplate/ApplicationTesting
   JobTemplate/StaticTypeCheck
   JobTemplate/PublishTestResults
   JobTemplate/PublishCoverageResults
   JobTemplate/Package
   JobTemplate/InstallPackage
   JobTemplate/PublishOnPyPI
   JobTemplate/PublishToGitHubPages
   JobTemplate/TagReleaseCommit
   JobTemplate/PublishReleaseNotes
   JobTemplate/Cleanup/index
   JobTemplate/Deprecated/index

.. raw:: latex

   \part{pyDummy Example}

.. toctree::
   :caption: pyDummy Example
   :hidden:

   pyDummy/pyDummy
   unittests/index
   coverage/index
   CodeCoverage
   Doc. Coverage Report <DocCoverage>
   Static Type Check Report ➚ <typing/index>

.. raw:: latex

   \part{Appendix}

.. toctree::
   :caption: Appendix
   :hidden:

   License
   Doc-License
   TODO