Adjusted documentation to latest changes.

doc/JobTemplate/ArtifactCleanUp.rst

@@ -47,10 +47,9 @@ Complex Example
          - PublishToGitHubPages
          - PublishTestResults
        with:
-         package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
+         package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
          remaining: |
-           ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.9
+           ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*
-           ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.10
 
 
 Parameters

doc/JobTemplate/BuildTheDocs.rst

@@ -10,6 +10,7 @@ This jobs compiles the documentation written in ReStructured Text with Sphinx us
 1. Checkout repository.
 2. Build the documentation.
 3. Upload the HTML documentation as an artifact.
+4. Publish the HTML documentation to GitHub Pages.
 
 **Dependencies:**
 
@@ -18,6 +19,7 @@ This jobs compiles the documentation written in ReStructured Text with Sphinx us
 * :gh:`actions/upload-artifact`
 
 
+
 Instantiation
 *************
 
@@ -29,8 +31,7 @@ Simple Example
    jobs:
      BuildTheDocs:
        uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
-       with:
+
-         artifact: Documentation
 
 Complex Example
 ===============
@@ -43,7 +44,7 @@ Complex Example
        needs:
          - Params
        with:
-         artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+         artifact: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
 
 
 Parameters
@@ -55,11 +56,13 @@ artifact
 +----------------+----------+----------+--------------+
 | Parameter Name | Required | Type     | Default      |
 +================+==========+==========+==============+
-| artifact       | yes      | string   | — — — —      |
+| artifact       | optional | string   | ``""``       |
 +----------------+----------+----------+--------------+
 
 Name of the documentation artifact.
 
+If no artifact name is given, the job directly publishes the documentation's HTML content to GitHub Pages.
+
 
 Secrets
 *******

doc/JobTemplate/CoverageCollection.rst

@@ -69,8 +69,8 @@ Complex Example
        needs:
          - Params
        with:
-         python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
+         python_version: ${{ needs.Params.outputs.python_version }}
-         artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.Coverage }}
+         artifact: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
        secrets:
          codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
 

doc/JobTemplate/Package.rst

@@ -50,9 +50,9 @@ Complex Example
          - Params
          - Coverage
        with:
-         python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
+         python_version: ${{ needs.Params.outputs.python_version }}
          requirements: -r build/requirements.txt
-         artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.Package }}
+         artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
 
 
 Parameters

doc/JobTemplate/PublishOnPyPI.rst

@@ -72,9 +72,9 @@ by that job. Finally, the list of requirements is overwritten to load a list of
          - Params
          - Package
        with:
-         python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
+         python_version: ${{ needs.Params.outputs.python_version }}
          requirements: -r dist/requirements.txt
-         artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.Package }}
+         artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
        secrets:
          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 

doc/JobTemplate/PublishToGitHubPages.rst

@@ -50,9 +50,9 @@ Complex Example
          - Coverage
          - StaticTypeCheck
        with:
-         doc: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+         doc: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
-         coverage: ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
+         coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
-         typing: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
+         typing: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
 
 
 Parameters

doc/JobTemplate/StaticTypeCheck.rst

@@ -48,12 +48,12 @@ Complex Example
        needs:
          - Params
        with:
-         python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
+         python_version: ${{ needs.Params.outputs.python_version }}
          commands: |
            touch pyTooling/__init__.py
            mypy --html-report htmlmypy -p pyTooling
          report: 'htmlmypy'
-         artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
+         artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
 
 Commands
 ========

doc/JobTemplate/UnitTesting.rst

@@ -40,7 +40,7 @@ Simple Example
          - Params
        with:
          jobs: ${{ needs.Params.outputs.python_jobs }}
-         artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.Unittesting }}
+         artifact: ${{ fromJson(needs.Params.outputs.artifact_names).unittesting }}
 
 
 Complex Example