v2.0.0

.github/workflows/_Checking_Pipeline.yml

@@ -6,21 +6,21 @@ on:
 
 jobs:
   UnitTestingParams:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r1
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
     with:
       name: pyDummy
-      python_version_list: "3.8 3.9 3.10 3.11 3.12 pypy-3.8 pypy-3.9 pypy-3.10"
-      disable_list: "windows:pypy-3.10"
+      python_version_list: "3.9 3.10 3.11 3.12 3.13 pypy-3.9 pypy-3.10"
+#      disable_list: "windows:pypy-3.10"
 
   PlatformTestingParams:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r1
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
     with:
       name: Platform
       python_version_list: ""
       system_list: "ubuntu windows macos mingw32 mingw64 clang64 ucrt64"
 
   UnitTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r1
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
     needs:
       - UnitTestingParams
     with:
@@ -33,7 +33,7 @@ jobs:
 #      coverage_html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
 
   PlatformTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r1
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
     needs:
       - PlatformTestingParams
     with:
@@ -48,7 +48,7 @@ jobs:
       coverage_html_artifact: ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_html }}
 
 #  Coverage:
-#    uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r1
+#    uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@main
 #    needs:
 #      - UnitTestingParams
 #    with:
@@ -58,7 +58,7 @@ jobs:
 #      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
 
   StaticTypeCheck:
-    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r1
+    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@main
     needs:
       - UnitTestingParams
     with:
@@ -68,8 +68,33 @@ jobs:
       html_report: 'htmlmypy'
       html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
+  DocCoverage:
+    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r1
+    needs:
+      - UnitTestingParams
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      directory: sphinx_reports
+#      fail_below: 70
+
+  ConfigParams:
+    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@main
+    needs:
+      - DocCoverage
+
+  Package:
+    uses: pyTooling/Actions/.github/workflows/Package.yml@main
+    needs:
+      - UnitTestingParams
+      - UnitTesting
+#      - Coverage
+      - PlatformTesting
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
+
   PublishCoverageResults:
-    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r1
+    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@main
     needs:
       - UnitTestingParams
       - UnitTesting
@@ -84,44 +109,63 @@ jobs:
       codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
 
   PublishTestResults:
-    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
+    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@main
     needs:
       - UnitTesting
       - PlatformTesting
     with:
       additional_merge_args: '-d "--pytest=rewrite-dunder-init;reduce-depth:pytest.tests.unit;reduce-depth:pytest.tests.platform"'
 
-  Package:
-    uses: pyTooling/Actions/.github/workflows/Package.yml@r1
-    needs:
-      - UnitTestingParams
-      - UnitTesting
-#      - Coverage
-      - PlatformTesting
-    with:
-      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
-      artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
-
 #  VerifyDocs:
-#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@r1
+#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@main
 #    needs:
 #      - UnitTestingParams
 #    with:
 #      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
 
-  BuildTheDocs:
-    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r1
+  Documentation:
+    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@main
     needs:
       - UnitTestingParams
+      - ConfigParams
+      - PublishTestResults
+      - PublishCoverageResults
 #      - VerifyDocs
     with:
-      artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      coverage_report_json_directory: ${{ needs.ConfigParams.outputs.coverage_report_json_directory }}
+#      unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
+#      coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
+      html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
 
-  PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r1
+  IntermediateCleanUp:
+    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r1
     needs:
       - UnitTestingParams
-      - BuildTheDocs
+      - PublishCoverageResults
+      - PublishTestResults
+      - Documentation
+    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 }}-
+
+  PDFDocumentation:
+    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@main
+    needs:
+      - UnitTestingParams
+      - Documentation
+    with:
+      document: actions
+      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
+      pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
+
+  PublishToGitHubPages:
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@main
+    needs:
+      - UnitTestingParams
+      - Documentation
+#      - PDFDocumentation
 #      - Coverage
       - PublishCoverageResults
       - StaticTypeCheck
@@ -131,7 +175,7 @@ jobs:
       typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   ReleasePage:
-    uses: pyTooling/Actions/.github/workflows/Release.yml@r1
+    uses: pyTooling/Actions/.github/workflows/Release.yml@main
     if: startsWith(github.ref, 'refs/tags')
     needs:
       - UnitTesting
@@ -142,7 +186,7 @@ jobs:
       - PublishToGitHubPages
 
   PublishOnPyPI:
-    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r1
+    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@main
     if: startsWith(github.ref, 'refs/tags')
     needs:
       - UnitTestingParams
@@ -156,18 +200,20 @@ jobs:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
   ArtifactCleanUp:
-    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r1
+    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main
     needs:
       - UnitTestingParams
       - PlatformTestingParams
       - UnitTesting
-      - PlatformTesting
 #      - Coverage
       - StaticTypeCheck
-#      - BuildTheDocs
-      - PublishToGitHubPages
-      - PublishCoverageResults
+      - PlatformTesting
+      - Documentation
+#      - PDFDocumentation
       - PublishTestResults
+      - PublishCoverageResults
+      - PublishToGitHubPages
+      - IntermediateCleanUp
     with:
       package: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
       remaining: |