Improve mypy execution and less dependencies and manual/hard-coded Bash commands.

.github/workflows/CompletePipeline.yml

@@ -196,10 +196,7 @@ jobs:
       - UnitTestingParams
     with:
       python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
-      commands: |
+      html_report:    ${{ needs.ConfigParams.outputs.typing_report_html_directory }}
-        ${{ needs.ConfigParams.outputs.mypy_prepare_command }}
-        mypy --html-report report/typing -p ${{ needs.ConfigParams.outputs.package_fullname }}
-      html_report:   'report/typing'
       html_artifact:  ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   DocCoverage:

.github/workflows/ExtractConfiguration.yml

@@ -98,6 +98,10 @@ on:
       coverage_report_json:
         description: ""
         value: ${{ jobs.Extract.outputs.coverage_report_json }}
+      typing_report_html_directory:
+        description: ""
+        value: ${{ jobs.Extract.outputs.typing_report_html_directory }}
+
 
 jobs:
   Extract:
@@ -120,6 +124,7 @@ jobs:
       coverage_report_json_directory:       ${{ steps.getVariables.outputs.coverage_report_json_directory }}
       coverage_report_json_filename:        ${{ steps.getVariables.outputs.coverage_report_json_filename }}
       coverage_report_json:                 ${{ steps.getVariables.outputs.coverage_report_json }}
+      typing_report_html_directory:         ${{ steps.getVariables.outputs.typing_report_html_directory }}
 
     steps:
       - name: ⏬ Checkout repository
@@ -194,6 +199,7 @@ jobs:
           coverageXMLFile =       Path("./coverage.xml")
           coverageJSONFile =      Path("./coverage.json")
           coverageRC =            "${{ inputs.coverage_config }}".strip()
+          typingHTMLDirectory =   Path("htmlmypy")
 
           # Read output paths from 'pyproject.toml' file
           if coverageRC == "pyproject.toml":
@@ -207,6 +213,7 @@ jobs:
               coverageHTMLDirectory = Path(pyProjectSettings["tool"]["coverage"]["html"]["directory"])
               coverageXMLFile =       Path(pyProjectSettings["tool"]["coverage"]["xml"]["output"])
               coverageJSONFile=       Path(pyProjectSettings["tool"]["coverage"]["json"]["output"])
+              typingHTMLDirectory =   Path(pyProjectSettings["tool"]["mypy"]["html_report"])
             else:
               print(f"File '{pyProjectFile}' not found.")
               print(f"::error title=FileNotFoundError::File '{pyProjectFile}' not found.")
@@ -245,6 +252,7 @@ jobs:
               coverage_report_json_directory={coverageJSONFile.parent.as_posix()}
               coverage_report_json_filename={coverageJSONFile.name}
               coverage_report_json={coverageJSONFile.as_posix()}
+              typing_report_html_directory={typingHTMLDirectory.as_posix()}
             """))
 
           print(dedent(f"""\
@@ -254,4 +262,5 @@ jobs:
               coverage html:       {coverageHTMLDirectory}
               coverage xml:        {coverageXMLFile}
               coverage json:       {coverageJSONFile}
+              typing html:         {typingHTMLDirectory}
           """))

.github/workflows/LaTeXDocumentation.yml

@@ -57,7 +57,7 @@ jobs:
   PDFDocumentation:
     name: 📓 Converting LaTeX Documentation to PDF
     runs-on: "ubuntu-${{ inputs.ubuntu_image_version }}"
-    continue-on-error: ${{ inputs.can-fail }}
+    continue-on-error: ${{ inputs.can-fail == 'true' }}
     steps:
       - name: 📥 Download artifacts '${{ inputs.latex_artifact }}' from 'SphinxDocumentation' job
         uses: pyTooling/download-artifact@v5

.github/workflows/PrepareJob.yml

@@ -255,6 +255,9 @@ jobs:
           version=${version}
           EOF
 
+# TODO: why not is_release_commit?
+# TODO: how to support version branches and hotfix releases on version branches?
+
       - name: 🔁 Find merged PullRequest from second parent of current SHA (${{ github.sha }})
         id: FindPullRequest
         if: steps.Classify.outputs.is_merge_commit == 'true'

.github/workflows/StaticTypeCheck.yml

@@ -40,14 +40,10 @@ on:
         required: false
         default: '-r tests/requirements.txt'
         type: string
-      commands:
-        description: 'Commands to run the static type checks.'
-        required: true
-        type: string
       html_report:
         description: 'Directory to upload as an artifact.'
         required: false
-        default: 'htmlmypy'
+        default: 'report/typing'
         type: string
       junit_report:
         description: 'junit file to upload as an artifact.'

.github/workflows/_Checking_JobTemplates.yml

@@ -84,10 +84,7 @@ jobs:
       - UnitTestingParams
     with:
       python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
-      commands: |
+      html_report:    ${{ needs.ConfigParams.outputs.typing_report_html_directory }}
-        ${{ needs.ConfigParams.outputs.mypy_prepare_command }}
-        mypy --html-report report/typing -p ${{ needs.ConfigParams.outputs.package_fullname }}
-      html_report:   'report/typing'
       html_artifact:  ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   DocCoverage:

.github/workflows/_Checking_Nightly.yml

@@ -55,6 +55,7 @@ jobs:
         version=4.2.0
         tool=myTool
         prog=program
+      tag: 4.2.0
       title: "Nightly Test Release"
       description: |
         This *nightly* release contains all latest and important artifacts created by %tool%'s CI pipeline.

doc/JobTemplate/Quality/StaticTypeCheck.rst

@@ -40,52 +40,60 @@ results can be converted to a HTML report and uploaded as an artifact.
 Instantiation
 *************
 
+Simple Example
+==============
+
+This example runs mypy for the Python package ``myPackage`` according to the configuration stored in
+:file:`pyproject.toml`. It prints a report into the job's log. In addition is generates a report in HTML format into the
+directory ``report/typing``.
+
 .. grid:: 2
 
    .. grid-item::
       :columns: 6
 
-      .. card:: Simple Example
-
-         This example runs mypy for the Python package ``myPackage``. It renders a report into the job's log. In
-         addition is generates a report in HTML format into the directory ``htmlmypy``.
-
       .. code-block:: yaml
 
          jobs:
            StaticTypeCheck:
              uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
              with:
-                  commands: |
+               html_report: 'htmlmpyp'
-                    mypy --html-report htmlmypy -p myPackage
+               artifact:    'TypeChecking'
-                  report:   'htmlmypy'
-                  artifact: TypeChecking
 
    .. grid-item::
       :columns: 6
 
-      .. card:: Complex Example
+      .. code-block:: toml
 
-         .. code-block:: yaml
+         [tool.mypy]
+         packages = ["myPackage"]
+         strict = true
+         pretty = true
+
+         html_report = "htmlmpyp"
+
+
+Complex Example
+===============
+
+To ease the handling of mypy parameters stored in :file:`pyproject.toml`, the :ref:`JOBTMPL/ExtractConfiguration` is
+used to extract the set configuration parameters for later usage. Similarly, :ref:`JOBTMPL/Parameters` is used to
+precompute the artifact's name.
+
+.. code-block:: yaml
 
    jobs:
-              StaticTypeCheck:
+     ConfigParams:
-                uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
+       uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
-                needs:
-                  - Params
        with:
-                  python_version: ${{ needs.Params.outputs.python_version }}
+         package_name: myPackage
-                  commands: |
-                    touch myFramework/__init__.py
-                    mypy --html-report htmlmypy -p myFramework.Extension
-                  report:   'htmlmypy'
-                  artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
 
-.. card:: Complex Example
+     Params:
+       uses: pyTooling/Actions/.github/workflows/Parameters.yml@r5
+       with:
+         package_name: myPackage
 
-   .. code-block:: yaml
-
-      jobs:
      StaticTypeCheck:
        uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r5
        needs:
@@ -93,40 +101,9 @@ Instantiation
          - Params
        with:
          python_version: ${{ needs.Params.outputs.python_version }}
-            commands: |
+         report:         ${{ needs.ConfigParams.outputs.typing_report_html_directory }}
-              ${{ needs.ConfigParams.outputs.mypy_prepare_command }}
-              mypy --html-report htmlmypy -p ${{ needs.ConfigParams.outputs.package_fullname }}
-            report:   'htmlmypy'
          artifact:       ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
 
-Commands
-********
-
-Example ``commands``:
-
-1. Regular package
-
-   .. code-block:: yaml
-
-      commands: mypy --html-report htmlmypy -p ToolName
-
-
-2. Parent namespace package
-
-   .. code-block:: yaml
-
-      commands: |
-        touch Parent/__init__.py
-        mypy --html-report htmlmypy -p ToolName
-
-3. Child namespace package
-
-   .. code-block:: yaml
-
-      commands: |
-        cd Parent
-        mypy --html-report ../htmlmypy -p ToolName
-
 
 .. _JOBTMPL/StaticTypeCheck/Parameters:
 
@@ -144,9 +121,7 @@ Parameter Summary
 +---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
 | :ref:`JOBTMPL/StaticTypeCheck/Input/requirements`                   | no       | string   | ``'-r tests/requirements.txt'``                                   |
 +---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
-| :ref:`JOBTMPL/StaticTypeCheck/Input/commands`                       | yes      | string   | — — — —                                                           |
+| :ref:`JOBTMPL/StaticTypeCheck/Input/html_report`                    | no       | string   | ``'report/typing'``                                               |
-+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
-| :ref:`JOBTMPL/StaticTypeCheck/Input/html_report`                    | no       | string   | ``'htmlmypy'``                                                    |
 +---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
 | :ref:`JOBTMPL/StaticTypeCheck/Input/junit_report`                   | no       | string   | ``'StaticTypingSummary.xml'``                                     |
 +---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
@@ -193,18 +168,6 @@ requirements
 :Description:     Python dependencies to be installed through *pip*.
 
 
-.. _JOBTMPL/StaticTypeCheck/Input/commands:
-
-commands
-========
-
-:Type:            string
-:Required:        yes
-:Default Value:   — — — —
-:Possible Values: tbd
-:Description:     tbd
-
-
 .. _JOBTMPL/StaticTypeCheck/Input/html_report:
 
 html_report
@@ -212,7 +175,7 @@ html_report
 
 :Type:            string
 :Required:        no
-:Default Value:   ``'htmlmypy'``
+:Default Value:   ``'report/typing'``
 :Possible Values: Any valid directory or subdirectory path.
 :Description:     The directory containing the generated HTML report.