v4.1.0

.github/workflows/ApplicationTesting.yml

@@ -188,8 +188,8 @@ jobs:
             f.write(f"pacboy_packages={' '.join(pacboyPackages)}\n")
 
       - name: '🟦 Setup MSYS2 for ${{ matrix.runtime }}'
-        if: matrix.system == 'msys2'
         uses: msys2/setup-msys2@v2
+        if: matrix.system == 'msys2'
         with:
           msystem: ${{ matrix.runtime }}
           update: true
@@ -198,8 +198,8 @@ jobs:
             ${{ inputs.pacboy }}
 
       - name: 🐍 Setup Python ${{ matrix.python }}
-        if: matrix.system != 'msys2'
         uses: actions/setup-python@v5
+        if: matrix.system != 'msys2'
         with:
           python-version: ${{ matrix.python }}
 

.github/workflows/ArtifactCleanUp.yml

@@ -47,13 +47,13 @@ jobs:
 
     steps:
       - name: 🗑️ Delete package Artifacts
-        if: ${{ ! startsWith(github.ref, 'refs/tags') }}
         uses: geekyeggo/delete-artifact@v5
+        if: ${{ ! startsWith(github.ref, 'refs/tags') }}
         with:
           name: ${{ inputs.package }}
 
       - name: 🗑️ Delete remaining Artifacts
-        if: ${{ inputs.remaining != '' }}
         uses: geekyeggo/delete-artifact@v5
+        if: ${{ inputs.remaining != '' }}
         with:
           name: ${{ inputs.remaining }}

.github/workflows/BuildTheDocs.yml

@@ -49,8 +49,8 @@ jobs:
           skip-deploy: true
 
       - name: 📤 Upload 'documentation' artifacts
-        if: inputs.artifact != ''
         uses: pyTooling/upload-artifact@v4
+        if: inputs.artifact != ''
         with:
           name: ${{ inputs.artifact }}
           working-directory: doc/_build/html

.github/workflows/NightlyRelease.yml

@@ -175,7 +175,7 @@ jobs:
           cat <<EOF >> __NoTeS__.md
 
           --------
-          Published from [${{ github.workflow }}](https://github.com/Paebbels/ghdl/actions/runs/${{ github.run_id }}) workflow triggered by @${{ github.actor }} on $(date '+%Y-%m-%d %H:%M:%S').
+          Published from [${{ github.workflow }}](https://github.com/Paebbels/ghdl/actions/runs/${{ github.run_id }}) workflow triggered by @${{ github.actor }} on $(date '+%Y-%m-%d %H:%M:%S %Z').
           EOF
 
           printf "%s\n" "Creating release '${{ inputs.nightly_name }}' ... "
@@ -343,12 +343,14 @@ jobs:
             if [[ "${asset}" == !*.zip ]]; then
               printf "%s\n" "${ANSI_LIGHT_GREEN}[ZIP]${ANSI_NOCOLOR}"
               asset="${asset##*!}"
-              printf "    %s\n" "Compressing artifact '${artifact}' to '${asset}' ..."
+              printf "::group::    %s\n" "Compressing artifact '${artifact}' to '${asset}' ..."
               (
                 cd "${artifact}" && \
                 zip -r "../${asset}" *
               )
-              if [[ $? -eq 0 ]]; then
+              retCode=$?
+              printf "::endgroup::\n"
+              if [[ $retCode -eq 0 ]]; then
                 printf "    %s\n" "Compression ${ANSI_LIGHT_GREEN}[OK]${ANSI_NOCOLOR}"
                 uploadFile="${asset}"
               else
@@ -430,17 +432,17 @@ jobs:
             # Add asset to JSON inventory
             if [[ "${{ inputs.inventory-json }}" != "" ]]; then
               if [[ "${categories}" != "${title}" ]]; then
-                printf "  %s\n" "adding file '${uploadFile}' with '${categories//;/ → }' to JSON inventory ..."
+                printf "  %s\n" "adding file '${uploadFile#*/}' with '${categories//;/ → }' to JSON inventory ..."
                 category=""
                 jsonEntry=$(jq -c -n \
                   --arg title "${title}" \
-                  --arg file "${uploadFile}" \
+                  --arg file "${uploadFile#*/}" \
                   '{"file": $file, "title": $title}' \
                 )
 
                 while [[ "${categories}" != "${category}" ]]; do
-                  category="${categories##*;}"
-                  categories="${categories%;*}"
+                  category="${categories##*,}"
+                  categories="${categories%,*}"
                   jsonEntry=$(jq -c -n --arg cat "${category}" --argjson value "${jsonEntry}" '{$cat: $value}')
                 done
 
@@ -450,7 +452,7 @@ jobs:
                   '$inventory * {"files": $file}' \
                 )
               else
-                printf "  %s\n" "adding file '${uploadFile}' to JSON inventory ... ${ANSI_LIGHT_YELLOW}[SKIPPED]${ANSI_NOCOLOR}"
+                printf "  %s\n" "adding file '${uploadFile#*/}' to JSON inventory ... ${ANSI_LIGHT_YELLOW}[SKIPPED]${ANSI_NOCOLOR}"
               fi
             fi
 

.github/workflows/PublishCoverageResults.yml

@@ -76,7 +76,7 @@ jobs:
           lfs: true
           submodules: true
 
-      - name: Download Artifacts
+      - name: 📥 Download Artifacts
         uses: pyTooling/download-artifact@v4
         with:
           pattern: ${{ inputs.coverage_artifacts_pattern }}
@@ -178,9 +178,9 @@ jobs:
           tree -pash report/coverage/html
 
       - name: 📤 Upload 'Coverage SQLite Database' artifact
+        uses: pyTooling/upload-artifact@v4
         if: inputs.coverage_sqlite_artifact != ''
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.coverage_sqlite_artifact }}
           path: .coverage
@@ -188,9 +188,9 @@ jobs:
           retention-days: 1
 
       - name: 📤 Upload 'Coverage XML Report' artifact
+        uses: pyTooling/upload-artifact@v4
         if: inputs.coverage_xml_artifact != ''
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.coverage_xml_artifact }}
           path: ${{ steps.getVariables.outputs.coverage_report_xml }}
@@ -198,9 +198,9 @@ jobs:
           retention-days: 1
 
       - name: 📤 Upload 'Coverage JSON Report' artifact
+        uses: pyTooling/upload-artifact@v4
         if: inputs.coverage_json_artifact != ''
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.coverage_json_artifact }}
           path: ${{ steps.getVariables.outputs.coverage_report_json }}
@@ -208,9 +208,9 @@ jobs:
           retention-days: 1
 
       - name: 📤 Upload 'Coverage HTML Report' artifact
+        uses: pyTooling/upload-artifact@v4
         if: inputs.coverage_html_artifact != ''
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.coverage_html_artifact }}
           working-directory: ${{ steps.getVariables.outputs.coverage_report_html_directory }}
@@ -219,18 +219,18 @@ jobs:
           retention-days: 1
 
       - name: 📊 Publish code coverage at CodeCov
+        uses: codecov/codecov-action@v5
         if: inputs.CodeCov == true
         continue-on-error: true
-        uses: codecov/codecov-action@v5
         with:
           files: ${{ steps.getVariables.outputs.coverage_report_xml }}
           flags: unittests
           env_vars: PYTHON
 
       - name: 📉 Publish code coverage at Codacy
+        uses: codacy/codacy-coverage-reporter-action@v1
         if: inputs.Codacy == true
         continue-on-error: true
-        uses: codacy/codacy-coverage-reporter-action@v1
         with:
           project-token: ${{ secrets.codacy_token }}
           coverage-reports: ${{ steps.getVariables.outputs.coverage_report_xml }}

.github/workflows/PublishTestResults.yml

@@ -65,7 +65,7 @@ jobs:
       - name: ⏬ Checkout repository
         uses: actions/checkout@v4
 
-      - name: Download Artifacts
+      - name: 📥 Download Artifacts
         uses: pyTooling/download-artifact@v4
         with:
           pattern: ${{ inputs.unittest_artifacts_pattern }}
@@ -82,7 +82,7 @@ jobs:
       - name: Rename JUnit files and move them all into 'junit/'
         run: |
           mkdir -p junit
-          find artifacts/ -type f -path "*TestReportSummary*.xml" -exec sh -c 'cp -v $0 "junit/$(basename $(dirname $0)).$(basename $0)"' {} ';'
+          find artifacts/ -type f -path "*.xml" -exec sh -c 'cp -v $0 "junit/$(basename $(dirname $0)).$(basename $0)"' {} ';'
           tree -pash junit
 
       - name: 🔁 Merge JUnit Unit Test Summaries
@@ -100,8 +100,8 @@ jobs:
           reporter: java-junit
 
       - name: 📤 Upload merged 'JUnit Test Summary' artifact
-        if: inputs.merged_junit_artifact != ''
         uses: pyTooling/upload-artifact@v4
+        if: inputs.merged_junit_artifact != ''
         with:
           name: ${{ inputs.merged_junit_artifact }}
           path: Unittesting.xml

.github/workflows/PublishToGitHubPages.yml

@@ -62,15 +62,15 @@ jobs:
           path: public
 
       - name: 📥 Download artifacts '${{ inputs.coverage }}' from 'Coverage' job
-        if: ${{ inputs.coverage != '' }}
         uses: pyTooling/download-artifact@v4
+        if: ${{ inputs.coverage != '' }}
         with:
           name: ${{ inputs.coverage }}
           path: public/coverage
 
       - name: 📥 Download artifacts '${{ inputs.typing }}' from 'StaticTypeCheck' job
-        if: ${{ inputs.typing != '' }}
         uses: pyTooling/download-artifact@v4
+        if: ${{ inputs.typing != '' }}
         with:
           name: ${{ inputs.typing }}
           path: public/typing

.github/workflows/Release.yml

@@ -49,8 +49,8 @@ jobs:
           echo "datetime=${RELEASE_DATETIME}" >> $GITHUB_OUTPUT
 
       - name: 📑 Create Release Page
-        id: createReleasePage
         uses: actions/create-release@v1
+        id: createReleasePage
         env:
           GITHUB_TOKEN: ${{ github.token }}
         with:

.github/workflows/SphinxDocumentation.yml

@@ -100,15 +100,15 @@ jobs:
           python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
 
       - name: 📥 Download artifacts '${{ inputs.unittest_xml_artifact }}' from 'Unittesting' job
-        if: inputs.unittest_xml_artifact != ''
         uses: pyTooling/download-artifact@v4
+        if: inputs.unittest_xml_artifact != ''
         with:
           name: ${{ inputs.unittest_xml_artifact }}
           path: ${{ inputs.unittest_xml_directory }}
 
       - name: 📥 Download artifacts '${{ inputs.coverage_json_artifact }}' from 'PublishCoverageResults' job
-        if: inputs.coverage_json_artifact != ''
         uses: pyTooling/download-artifact@v4
+        if: inputs.coverage_json_artifact != ''
         with:
           name: ${{ inputs.coverage_json_artifact }}
           path: ${{ inputs.coverage_report_json_directory }}
@@ -122,9 +122,9 @@ jobs:
           sphinx-build -v -n -b html -d _build/doctrees -j $(nproc) -w _build/html.log . _build/html
 
       - name: 📤 Upload 'HTML Documentation' artifact
+        uses: pyTooling/upload-artifact@v4
         if: inputs.html_artifact != ''
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.html_artifact }}
           working-directory: ${{ inputs.doc_directory }}/_build/html
@@ -157,15 +157,15 @@ jobs:
           python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
 
       - name: 📥 Download artifacts '${{ inputs.unittest_xml_artifact }}' from 'Unittesting' job
-        if: inputs.unittest_xml_artifact != ''
         uses: pyTooling/download-artifact@v4
+        if: inputs.unittest_xml_artifact != ''
         with:
           name: ${{ inputs.unittest_xml_artifact }}
           path: ${{ inputs.unittest_xml_directory }}
 
       - name: 📥 Download artifacts '${{ inputs.coverage_json_artifact }}' from 'PublishCoverageResults' job
-        if: inputs.coverage_json_artifact != ''
         uses: pyTooling/download-artifact@v4
+        if: inputs.coverage_json_artifact != ''
         with:
           name: ${{ inputs.coverage_json_artifact }}
           path: ${{ inputs.coverage_report_json_directory }}
@@ -263,9 +263,9 @@ jobs:
           done
 
       - name: 📤 Upload 'LaTeX Documentation' artifact
+        uses: pyTooling/upload-artifact@v4
         if: inputs.latex_artifact != ''
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.latex_artifact }}
           working-directory: ${{ inputs.doc_directory }}/_build/latex

.github/workflows/StaticTypeCheck.yml

@@ -87,9 +87,9 @@ jobs:
         run: ${{ inputs.commands }}
 
       - name: 📤 Upload 'Static Typing Report' HTML artifact
+        uses: pyTooling/upload-artifact@v4
         if: ${{ inputs.html_artifact != '' }}
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.html_artifact }}
           working-directory: ${{ inputs.html_report }}
@@ -98,9 +98,9 @@ jobs:
           retention-days: 1
 
       - name: 📤 Upload 'Static Typing Report' JUnit artifact
+        uses: pyTooling/upload-artifact@v4
         if: ${{ inputs.junit_artifact != '' }}
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.junit_artifact }}
           path: ${{ inputs.junit_report }}

.github/workflows/UnitTesting.yml

@@ -282,8 +282,8 @@ jobs:
 # Python setup
 
       - name: '🟦 Setup MSYS2 for ${{ matrix.runtime }}'
-        if: matrix.system == 'msys2'
         uses: msys2/setup-msys2@v2
+        if: matrix.system == 'msys2'
         with:
           msystem: ${{ matrix.runtime }}
           update: true
@@ -292,8 +292,8 @@ jobs:
             ${{ inputs.pacboy }}
 
       - name: 🐍 Setup Python ${{ matrix.python }}
-        if: matrix.system != 'msys2'
         uses: actions/setup-python@v5
+        if: matrix.system != 'msys2'
         with:
           python-version: ${{ matrix.python }}
 
@@ -392,9 +392,9 @@ jobs:
 # Upload artifacts
 
       - name: 📤 Upload '${{ inputs.unittest_report_xml_filename }}' artifact
+        uses: pyTooling/upload-artifact@v4
         if: inputs.unittest_xml_artifact != ''
         continue-on-error: true
-        uses: pyTooling/upload-artifact@v4
         with:
           name: ${{ inputs.unittest_xml_artifact }}-${{ matrix.system }}-${{ matrix.runtime }}-${{ matrix.python }}
           working-directory: ${{ inputs.unittest_report_xml_directory }}

.github/workflows/_Checking_JobTemplates.yml

@@ -74,7 +74,7 @@ jobs:
       html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   DocCoverage:
-    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
+    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@main
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -141,7 +141,7 @@ jobs:
       latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
 
   IntermediateCleanUp:
-    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
+    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@main
     needs:
       - UnitTestingParams
       - PublishCoverageResults

ExamplePipeline.yml

@@ -1,178 +0,0 @@
-# ==================================================================================================================== #
-# Authors:                                                                                                             #
-#   Patrick Lehmann                                                                                                    #
-#   Unai Martinez-Corral                                                                                               #
-#                                                                                                                      #
-# ==================================================================================================================== #
-# Copyright 2020-2024 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.                                                     #
-# You may obtain a copy of the License at                                                                              #
-#                                                                                                                      #
-#   http://www.apache.org/licenses/LICENSE-2.0                                                                         #
-#                                                                                                                      #
-# Unless required by applicable law or agreed to in writing, software                                                  #
-# distributed under the License is distributed on an "AS IS" BASIS,                                                    #
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.                                             #
-# See the License for the specific language governing permissions and                                                  #
-# limitations under the License.                                                                                       #
-#                                                                                                                      #
-# SPDX-License-Identifier: Apache-2.0                                                                                  #
-# ==================================================================================================================== #
-name: Pipeline
-
-on:
-  workflow_dispatch:
-
-jobs:
-
-  # This job is a workaround for global variables
-  # See https://github.com/actions/runner/issues/480
-  Params:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
-    with:
-      name: ToolName
-      # Optional
-      system_list: 'ubuntu windows msys2 macos'
-      python_version: '3.10'
-      python_version_list: '3.8 3.9 3.10'
-
-  UnitTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
-    needs:
-      - Params
-    with:
-      jobs: ${{ needs.Params.outputs.python_jobs }}
-      # Optional
-      requirements: '-r tests/requirements.txt'
-      pacboy: >-
-        python-pip:p
-        python-wheel:p
-        python-coverage:p
-        python-lxml:p
-      mingw_requirements: '-r tests/requirements.mingw.txt'
-      tests_directory: 'tests'
-      unittest_directory: 'unit'
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}
-
-  Coverage:
-    uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@main
-    needs:
-      - Params
-    with:
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
-      # Optional
-      python_version: ${{ needs..Params.outputs.python_version }}
-      requirements: '-r tests/requirements.txt'
-      tests_directory: 'tests'
-      unittest_directory: 'unit'
-    secrets:
-      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-
-  StaticTypeCheck:
-    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@main
-    needs:
-      - Params
-    with:
-      commands: |
-        mypy --junit-xml StaticTypingSummary.xml --html-report htmlmypy -p ToolName
-      html_artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
-      junit_artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_junit }}
-      # Optional
-      python_version: ${{ needs..Params.outputs.python_version }}
-      requirements: '-r tests/requirements.txt'
-      html_report: 'htmlmypy'
-      junit_report: 'StaticTypingSummary.xml'
-      allow_failure: true
-
-  PublishTestResults:
-    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@main
-    needs:
-      - UnitTesting
-      - StaticTypeCheck
-    with:
-      # Optional
-      report_files: artifacts/**/*.xml
-
-  Package:
-    uses: pyTooling/Actions/.github/workflows/Package.yml@main
-    needs:
-      - Params
-      - Coverage
-    with:
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
-      # Optional
-      python_version: ${{ needs..Params.outputs.python_version }}
-      requirements: 'wheel'
-
-  Release:
-    uses: pyTooling/Actions/.github/workflows/Release.yml@main
-    if: startsWith(github.ref, 'refs/tags')
-    needs:
-      - UnitTesting
-      - Coverage
-      - StaticTypeCheck
-      - Package
-
-  PublishOnPyPI:
-    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@main
-    if: startsWith(github.ref, 'refs/tags')
-    needs:
-      - Params
-      - Release
-      - Package
-    with:
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
-      # Optional
-      python_version: ${{ needs..Params.outputs.python_version }}
-      requirements: 'wheel twine'
-    secrets:
-      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
-
-  VerifyDocs:
-    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@main
-    needs:
-      - Params
-    with:
-      # Optional
-      python_version: ${{ needs..Params.outputs.python_version }}
-
-  BuildTheDocs:
-    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@main
-    needs:
-      - Params
-      - VerifyDocs
-    with:
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
-
-  PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@main
-    needs:
-      - Params
-      - BuildTheDocs
-      - Coverage
-      - StaticTypeCheck
-    with:
-      doc: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
-      # Optional
-      coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
-      typing: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
-
-  ArtifactCleanUp:
-    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main
-    needs:
-      - Params
-      - PublishTestResults
-      - Coverage
-      - StaticTypeCheck
-      - BuildTheDocs
-      - PublishToGitHubPages
-    with:
-      package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
-      remaining: |
-        ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*
-        ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
-        ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
-        ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_junit }}
-        ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}

README.md

@@ -100,7 +100,7 @@ As shown in the screenshots above, the expected order is:
 
 ### Example pipeline
 
-[ExamplePipeline.yml](ExamplePipeline.yml) is an example Workflow which uses all of the Reusable Workflows.
+ExamplePipeline.yml is an example Workflow which uses all of the Reusable Workflows.
 Python package/tool developers can copy it into their repos, in order to use al the reusable workflows straightaway.
 Minimal required modifications are the following:
 

doc/requirements.txt

@@ -15,5 +15,5 @@ sphinxcontrib-mermaid ~= 1.0
 autoapi >= 2.0.1
 sphinx_design ~= 0.6.1
 sphinx-copybutton >= 0.5.2
-sphinx_autodoc_typehints ~= 2.5
+sphinx_autodoc_typehints ~= 3.0
 sphinx_reports ~= 0.7