Document all recently added workflow templates.

doc/JobTemplate/Cleanup/ArtifactCleanup.rst

@@ -0,0 +1,90 @@
+.. _JOBTMPL/ArtifactCleanup:
+
+ArtifactCleanUp
+###############
+
+This job removes artifacts used to exchange data from job to job.
+
+**Behavior:**
+
+1. Delete the package artifact if the current pipeline run was not a tagged run.
+2. Delete all remaining artifacts if given as a parameter.
+
+**Dependencies:**
+
+* :gh:`geekyeggo/delete-artifact`
+
+
+Instantiation
+*************
+
+Simple Example
+==============
+
+The simplest variant just uses the artifact name for the package.
+
+.. code-block:: yaml
+
+   jobs:
+     ArtifactCleanUp:
+       uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r5
+       with:
+         package: Package
+
+
+Complex Example
+===============
+
+.. code-block:: yaml
+
+   jobs:
+     ArtifactCleanUp:
+       uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r5
+       needs:
+         - Params
+         - UnitTesting
+         - BuildTheDocs
+         - PublishToGitHubPages
+         - PublishTestResults
+       with:
+         package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
+         remaining: |
+           ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*
+
+
+Parameters
+**********
+
+package
+=======
+
++----------------+----------+----------+----------+
+| Parameter Name | Required | Type     | Default  |
++================+==========+==========+==========+
+| package        | yes      | string   | — — — —  |
++----------------+----------+----------+----------+
+
+Artifacts to be removed on not tagged runs.
+
+
+remaining
+=========
+
++----------------+----------+----------+----------+
+| Parameter Name | Required | Type     | Default  |
++================+==========+==========+==========+
+| remaining      | optional | string   | ``""``   |
++----------------+----------+----------+----------+
+
+Artifacts to be removed unconditionally.
+
+
+Secrets
+*******
+
+This job template needs no secrets.
+
+Results
+*******
+
+This job template has no output parameters.

doc/JobTemplate/Cleanup/IntermediateCleanup.rst

@@ -0,0 +1,22 @@
+.. _JOBTMPL/IntermediateCleanUp:
+
+IntermediateCleanUp
+###################
+
+.. todo:: IntermediateCleanUp:Needs documentation.
+
+**Behavior:**
+
+.. todo:: IntermediateCleanUp:Behavior needs documentation.
+
+**Dependencies:**
+
+.. todo:: IntermediateCleanUp:Dependencies needs documentation.
+
+Instantiation
+*************
+
+Simple Example
+==============
+
+.. todo:: IntermediateCleanUp:Simple example needs documentation.

doc/JobTemplate/Cleanup/index.rst

@@ -0,0 +1,28 @@
+.. _JOBTMPL/Cleanup:
+
+Cleanup
+#######
+
+The category *cleanup* provides workflow templates implementing artifact cleanups (removals) from pipelines.
+
+Running lots of unit testing, platform testing and application testing variants (operating system |times| Python version
+|times| environment) creates dozens to hundrets of artifacts (unit test report, code coverage report, ...). This
+consumes pipeline storage which can be freed up. Moreover, it's unclear which artifacts contain the final unit test and
+code coverage reports. Thus, it's benefitial, to remove intermediate artifacts after merging reports into one summary
+report.
+
+.. topic:: Intermediate cleanups
+
+   * :ref:`JOBTMPL/IntermediateCleanup` - remove intermediate artifacts after merging reports into one summary report.
+
+
+.. topic:: Final cleanups
+
+   * :ref:`JOBTMPL/ArtifactCleanup` - remove artifacts after publising results and creating release assets.
+
+
+.. toctree::
+   :hidden:
+
+   IntermediateCleanup
+   ArtifactCleanup