pyTooling · Paebbels · Apr 18, 2025 · Apr 20, 2025 · Apr 21, 2025 · Apr 25, 2025
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,3 @@
+* @Paebbels
+
+/.github/ @Paebbels
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -10,7 +10,5 @@ updates:
       - Dependencies
     assignees:
       - Paebbels
-    reviewers:
-      - Paebbels
     schedule:
       interval: "daily"    # Checks on Monday trough Friday.
diff --git a/.github/workflows/ApplicationTesting.yml b/.github/workflows/ApplicationTesting.yml
@@ -4,7 +4,7 @@
 #   Unai Martinez-Corral                                                                                               #
 #                                                                                                                      #
 # ==================================================================================================================== #
-# Copyright 2020-2024 The pyTooling Authors                                                                            #
+# Copyright 2020-2025 The pyTooling Authors                                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -134,20 +134,21 @@ jobs:
 
           packages = {
             "coverage":            "python-coverage:p",
-            "docstr_coverage":     "python-pyyaml:p",
+            "docstr_coverage":     "python-pyyaml:p python-types-pyyaml:p",
             "igraph":              "igraph:p",
             "jinja2":              "python-markupsafe:p",
             "lxml":                "python-lxml:p",
             "numpy":               "python-numpy:p",
             "markupsafe":          "python-markupsafe:p",
             "pip":                 "python-pip:p",
-            "pyyaml":              "python-pyyaml:p",
+            "pyyaml":              "python-pyyaml:p python-types-pyyaml:p",
             "ruamel.yaml":         "python-ruamel-yaml:p python-ruamel.yaml.clib:p",
             "sphinx":              "python-markupsafe:p",
             "tomli":               "python-tomli:p",
             "wheel":               "python-wheel:p",
             "pyEDAA.ProjectModel": "python-ruamel-yaml:p python-ruamel.yaml.clib:p python-lxml:p",
             "pyEDAA.Reports":      "python-ruamel-yaml:p python-ruamel.yaml.clib:p python-lxml:p",
+            "sphinx-reports":      "python-markupsafe:p python-pyaml:p python-types-pyyaml:p",
           }
           subPackages = {
             "pytooling": {

diff --git a/.github/workflows/ArtifactCleanUp.yml b/.github/workflows/ArtifactCleanUp.yml
@@ -4,7 +4,7 @@
 #   Unai Martinez-Corral                                                                                               #
 #                                                                                                                      #
 # ==================================================================================================================== #
-# Copyright 2020-2024 The pyTooling Authors                                                                            #
+# Copyright 2020-2025 The pyTooling Authors                                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #

diff --git a/.github/workflows/BuildTheDocs.yml b/.github/workflows/BuildTheDocs.yml
@@ -4,7 +4,7 @@
 #   Unai Martinez-Corral                                                                                               #
 #                                                                                                                      #
 # ==================================================================================================================== #
-# Copyright 2020-2024 The pyTooling Authors                                                                            #
+# Copyright 2020-2025 The pyTooling Authors                                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -38,7 +38,7 @@ jobs:
 
     steps:
       - name: '❗ Deprecation message'
-        run: printf "%s\n" "::warning title=Deprecated::'BuildTheDocs.yml' is not maintained anymore. Please switch to 'SphinxDocumentation.yml', 'LaTeXDocumentation.yml' and 'ExtractConfiguration.yml'."
+        run: printf "::warning title=%s::%s\n" "Deprecated" "'BuildTheDocs.yml' is not maintained anymore. Please switch to 'SphinxDocumentation.yml', 'LaTeXDocumentation.yml' and 'ExtractConfiguration.yml'."
 
       - name: ⏬ Checkout repository
         uses: actions/checkout@v4

diff --git a/.github/workflows/CheckDocumentation.yml b/.github/workflows/CheckDocumentation.yml
@@ -3,7 +3,7 @@
 #   Patrick Lehmann                                                                                                    #
 #                                                                                                                      #
 # ==================================================================================================================== #
-# Copyright 2020-2024 The pyTooling Authors                                                                            #
+# Copyright 2020-2025 The pyTooling Authors                                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -64,9 +64,20 @@ jobs:
       - name: Run 'interrogate' Documentation Coverage Check
         continue-on-error: true
         run: |
-          interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} && printf "%s\n" "::error title=interrogate::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
+          set +e
+
+          interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
+          if [[ $? -ne 0 ]]; then
+            printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
+          fi
 
       - name: Run 'docstr_coverage' Documentation Coverage Check
         continue-on-error: true
         run: |
-          docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} && printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
+          set +e
+
+          docstr-coverage --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
+          if [[ $? -ne 0 ]]; then
+            printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
+          fi
+
diff --git a/.github/workflows/CompletePipeline.yml b/.github/workflows/CompletePipeline.yml
@@ -3,7 +3,7 @@
 #   Patrick Lehmann                                                                                                    #
 #                                                                                                                      #
 # ==================================================================================================================== #
-# Copyright 2020-2024 The pyTooling Authors                                                                            #
+# Copyright 2020-2025 The pyTooling Authors                                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -96,35 +96,38 @@ on:
       codecov:
         description: 'Publish merged coverage and unittest reports to Codecov.'
         required: false
-        default: false
-        type: boolean
+        default: 'false'
+        type:    string
       codacy:
         description: 'Publish merged coverage report to Codacy.'
         required: false
-        default: false
-        type: boolean
+        default: 'false'
+        type: string
       dorny:
         description: 'Publish merged unittest report via Dorny Test-Reporter.'
         required: false
-        default: false
-        type: boolean
+        default: 'false'
+        type: string
       cleanup:
         description: 'Cleanup artifacts afterwards.'
         required: false
-        default: true
-        type: boolean
+        default: 'true'
+        type: string
     secrets:
       PYPI_TOKEN:
         description: "Token for pushing releases to PyPI."
         required: false
       CODECOV_TOKEN:
         description: "Token for pushing coverage and unittest results to Codecov."
         required: false
-      CODACY_PROJECT_TOKEN:
+      CODACY_TOKEN:
         description: "Token for pushing coverage results to Codacy."
         required: false
 
 jobs:
+  Prepare:
+    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@dev
+
   ConfigParams:
     uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
     with:
@@ -138,22 +141,34 @@ jobs:
       package_name:        ${{ inputs.package_name }}
       python_version:      ${{ inputs.unittest_python_version }}
       python_version_list: ${{ inputs.unittest_python_version_list }}
-      system_list:  ${{ inputs.unittest_system_list }}
-      include_list: ${{ inputs.unittest_include_list }}
-      exclude_list: ${{ inputs.unittest_exclude_list }}
-      disable_list: ${{ inputs.unittest_disable_list }}
+      system_list:         ${{ inputs.unittest_system_list }}
+      include_list:        ${{ inputs.unittest_include_list }}
+      exclude_list:        ${{ inputs.unittest_exclude_list }}
+      disable_list:        ${{ inputs.unittest_disable_list }}
 
-  AppTestingParams:
+#  AppTestingParams:
+#    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
+#    with:
+#      package_namespace:   ${{ inputs.package_namespace }}
+#      package_name:        ${{ inputs.package_name }}
+#      python_version:      ${{ inputs.apptest_python_version }}
+#      python_version_list: ${{ inputs.apptest_python_version_list }}
+#      system_list:         ${{ inputs.apptest_system_list }}
+#      include_list:        ${{ inputs.apptest_include_list }}
+#      exclude_list:        ${{ inputs.apptest_exclude_list }}
+#      disable_list:        ${{ inputs.apptest_disable_list }}
+
+  InstallParams:
     uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       package_namespace:   ${{ inputs.package_namespace }}
       package_name:        ${{ inputs.package_name }}
-      python_version:      ${{ inputs.apptest_python_version }}
-      python_version_list: ${{ inputs.apptest_python_version_list }}
-      system_list:         ${{ inputs.apptest_system_list }}
-      include_list:        ${{ inputs.apptest_include_list }}
-      exclude_list:        ${{ inputs.apptest_exclude_list }}
-      disable_list:        ${{ inputs.apptest_disable_list }}
+      python_version:      ${{ inputs.unittest_python_version }}
+      python_version_list: ''
+      system_list:         ${{ inputs.unittest_system_list }}
+      include_list:        ${{ inputs.unittest_include_list }}
+      exclude_list:        ${{ inputs.unittest_exclude_list }}
+      disable_list:        ${{ inputs.unittest_disable_list }}
 
   UnitTesting:
     uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
@@ -180,7 +195,7 @@ jobs:
       commands: |
         ${{ needs.ConfigParams.outputs.mypy_prepare_command }}
         mypy --html-report report/typing -p ${{ needs.ConfigParams.outputs.package_fullname }}
-      html_report: 'report/typing'
+      html_report:   'report/typing'
       html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   DocCoverage:
@@ -190,18 +205,29 @@ jobs:
       - UnitTestingParams
     with:
       python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
-      directory:      ${{ inputs.package_namespace }}/${{ inputs.package_name }}
-#      fail_below: 70
+      directory:      ${{ needs.ConfigParams.outputs.package_directory }}
 
   Package:
     uses: pyTooling/Actions/.github/workflows/Package.yml@dev
     needs:
       - UnitTestingParams
-      - UnitTesting
+#      - UnitTesting
     with:
       python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
       artifact:       ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
 
+  Install:
+    uses: pyTooling/Actions/.github/workflows/InstallPackage.yml@dev
+    needs:
+      - ConfigParams
+      - UnitTestingParams
+      - InstallParams
+      - Package
+    with:
+      jobs:         ${{ needs.InstallParams.outputs.python_jobs }}
+      wheel:        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
+      package_name: ${{ needs.ConfigParams.outputs.package_fullname }}
+
 #  AppTesting:
 #    uses: pyTooling/Actions/.github/workflows/ApplicationTesting.yml@dev
 #    needs:
@@ -233,7 +259,7 @@ jobs:
       codacy:                         ${{ inputs.codacy }}
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-      CODACY_TOKEN:  ${{ secrets.CODACY_PROJECT_TOKEN }}
+      CODACY_TOKEN:  ${{ secrets.CODACY_TOKEN }}
 
   PublishTestResults:
     uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
@@ -242,15 +268,13 @@ jobs:
       - UnitTestingParams
       - UnitTesting
     with:
-      additional_merge_args:  '-d "--pytest=rewrite-dunder-init;reduce-depth:pytest.tests.unit"'
-      testsuite-summary-name: ${{ inputs.package_name }}
+      testsuite-summary-name: ${{ needs.ConfigParams.outputs.package_fullname }}
       merged_junit_filename:  ${{ needs.ConfigParams.outputs.unittest_merged_report_xml_filename }}
       merged_junit_artifact:  ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
       dorny:                  ${{ inputs.dorny }}
       codecov:                ${{ inputs.codecov }}
-
     secrets:
-      CODECOV_TOKEN:          ${{ secrets.CODECOV_TOKEN }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
 #  VerifyDocs:
 #    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
@@ -281,8 +305,7 @@ jobs:
       - UnitTestingParams
       - PublishCoverageResults
       - PublishTestResults
-      - Documentation
-    if: ${{ inputs.cleanup }}
+    if: inputs.cleanup  == 'true'
     with:
       sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
       xml_unittest_artifacts_prefix:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
@@ -310,26 +333,57 @@ jobs:
       coverage: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
       typing:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
-  ReleasePage:
-    uses: pyTooling/Actions/.github/workflows/Release.yml@dev
-    if: startsWith(github.ref, 'refs/tags')
+  TriggerTaggedRelease:
+    uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@dev
     needs:
+      - Prepare
+      - UnitTesting
+      - Install
+#      - AppTesting
+#      - StaticTypeCheck
       - Package
+      - PublishToGitHubPages
+    if: needs.Prepare.outputs.is_release_commit
+    permissions:
+      contents: write  # required for create tag
+      actions:  write  # required for trigger workflow
+    with:
+      version:  ${{ needs.Prepare.outputs.version }}
+      auto_tag: ${{ needs.Prepare.outputs.is_release_commit }}
+    secrets: inherit
+
+  ReleasePage:
+    uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@dev
+    needs:
+      - Prepare
+      - UnitTesting
+      - Install
 #      - AppTesting
+#      - StaticTypeCheck
+      - Package
       - PublishToGitHubPages
+    if: needs.Prepare.outputs.is_release_tag == 'true'
+    permissions:
+      contents: write
+      actions:  write
+    with:
+      tag: ${{ needs.Prepare.outputs.version }}
+    secrets: inherit
 
   PublishOnPyPI:
     uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
-    if: startsWith(github.ref, 'refs/tags')
     needs:
+      - Prepare
       - UnitTestingParams
+      - Package
       - ReleasePage
+    if: needs.Prepare.outputs.is_release_tag == 'true'
     with:
       python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
       requirements: -r dist/requirements.txt
       artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
     secrets:
-      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+      PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
 
   ArtifactCleanUp:
     uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
@@ -344,7 +398,7 @@ jobs:
       - PublishToGitHubPages
 #      - PublishOnPyPI
       - IntermediateCleanUp
-    if: ${{ inputs.cleanup }}
+    if: inputs.cleanup  == 'true'
     with:
       package: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
       remaining: |

diff --git a/.github/workflows/CoverageCollection.yml b/.github/workflows/CoverageCollection.yml
@@ -4,7 +4,7 @@
 #   Unai Martinez-Corral                                                                                               #
 #                                                                                                                      #
 # ==================================================================================================================== #
-# Copyright 2020-2024 The pyTooling Authors                                                                            #
+# Copyright 2020-2025 The pyTooling Authors                                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -72,7 +72,7 @@ jobs:
 
     steps:
       - name: '❗ Deprecation message'
-        run: printf "%s\n" "::warning title=Deprecated::'CoverageCollection.yml' is not maintained anymore. Please switch to 'UnitTesting.yml', 'PublishCoverageResults.yml' and 'PublishTestResults.yml'."
+        run: printf "::warning title=%s::%s\n" "Deprecated" "'CoverageCollection.yml' is not maintained anymore. Please switch to 'UnitTesting.yml', 'PublishCoverageResults.yml' and 'PublishTestResults.yml'."
 
       - name: ⏬ Checkout repository
         uses: actions/checkout@v4