v2.1.0

.github/workflows/Pipeline.yml

@@ -5,231 +5,144 @@ on:
   pull_request:
 
 jobs:
-  Build-OSVVM:
-    name: Build OSVVM
-    runs-on: ubuntu-24.04
-    steps:
-      - name: ⏬ Checkout repository
-        uses: actions/checkout@v4
-        with:
-          lfs: true
-          submodules: true
-
-      - name: 🔧 Install tcllib
-        run: sudo apt-get install -y --no-install-recommends tcllib
-
-      - name: Setup GHDL ${{ inputs.ghdl_backend }}
-        uses: ghdl/setup-ghdl@v1
-        with:
-          version: latest
-          backend: llvm
-
-      - name: Prepare
-        run: |
-          mkdir -p temp/ghdl
-
-      - name: 🔨 Pre-compile OSVVM
-        run: |
-          cd temp/ghdl
-
-          tee run.tcl <<EOF
-          source ../../lib/OSVVM-Scripts/StartGHDL.tcl
-          build ../../lib/OsvvmLibraries.pro OsvvmLibraries
-          EOF
-          printf "=================\n"
-
-          tclsh run.tcl
-
-      - name: 📤 Upload 'GHDL-OSVVM-Report' artifacts
-        uses: pyTooling/upload-artifact@v4
-        continue-on-error: true
-        with:
-          name: GHDL-OSVVM-Report
-          working-directory: temp/ghdl
-          path: |
-            logs
-            reports
-            *.html
-            *.xml
-            *.yml
-          retention-days: 1
-
-      - name: 📤 Upload 'GHDL-OSVVM' artifacts
-        uses: pyTooling/upload-artifact@v4
-        with:
-          name: GHDL-OSVVM
-          working-directory: temp/ghdl
-          path: |
-            VHDL_LIBS
-          retention-days: 1
-
-      - name: 📤 Upload 'GHDL-OSVVM-Generated' artifacts
-        uses: pyTooling/upload-artifact@v4
-        continue-on-error: true
-        with:
-          name: GHDL-OSVVM-Generated
-#          working-directory: temp/ghdl
-          path: |
-            lib/osvvm/*_generated.vhd
-          retention-days: 1
-
-  Build-PoC:
-    name: Build PoC
-    runs-on: ubuntu-24.04
+  Prepare:
+    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r6
+    with:
+      main_branch:    'master'
+      release_branch: 'master'
+
+  Simulate:
+    uses: ./.github/workflows/Simulate.yml
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { simulator: 'nvc',  backend: '',      version: 'latest', can-fail: false }
+          - { simulator: 'ghdl', backend: 'mcode', version: 'latest', can-fail: false }
+          - { simulator: 'ghdl', backend: 'llvm',  version: 'latest', can-fail: false }
+    with:
+      simulator:    ${{ matrix.simulator }}
+      ghdl-version: ${{ matrix.version }}
+      ghdl-backend: ${{ matrix.backend }}
+      nvc-version:  ${{ matrix.version }}
+      can-fail:     ${{ matrix.can-fail }}
+
+  PublishTestResults:
+    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r6
     needs:
-      - Build-OSVVM
+      - Simulate
+#    if: success() || failure()
+    with:
+      unittest_artifacts_pattern: 'PoC-Report-XML-*'
+      testsuite-summary-name:     'The PoC Library'
+      merge-input-dialect:        'Any-JUnit'
+      merged_junit_filename:      'unittest.xml'
+      merged_junit_artifact:      'PoC-Report-XML'
+      dorny:                      ${{ inputs.dorny }}
+#      codecov:                    ${{ inputs.codecov }}
+#    secrets:
+#      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  IntermediateCleanUp:
+    name: 🗑️ Intermediate Artifact Cleanup
+    runs-on: 'ubuntu-24.04'
+    needs:
+      - Simulate
+      - PublishTestResults
+#    if: success() || failure()
     steps:
-      - name: ⏬ Checkout repository
-        uses: actions/checkout@v4
-        with:
-          lfs: true
-          submodules: true
-
-      - name: 🔧 Install tcllib
-        run: sudo apt-get install -y --no-install-recommends tcllib
-
-      - name: Setup GHDL ${{ inputs.ghdl_backend }}
-        uses: ghdl/setup-ghdl@v1
-        with:
-          version: latest
-          backend: llvm
-
-      - name: Prepare
-        run: |
-          mkdir -p temp/ghdl
-
-          mv src/common/my_project.vhdl.template tb/common/my_project.vhdl
-
-      - name: 📥 Download artifacts 'GHDL-OSVVM' from 'Build-OSVVM' job
-        uses: pyTooling/download-artifact@v4
-        with:
-          name: GHDL-OSVVM
-          path: temp/ghdl
-
-      - name: 📥 Download artifacts 'GHDL-OSVVM-Generated' from 'Build-OSVVM' job
-        uses: pyTooling/download-artifact@v4
-        with:
-          name: GHDL-OSVVM-Generated
-#          path: temp/ghdl
-
-      - name: 🔨 Pre-compile PoC
-        run: |
-          ls -lAh lib/osvvm/*_generated.vhd
-
-          cd temp/ghdl
-
-          tee run.tcl <<EOF
-          source ../../lib/OSVVM-Scripts/StartGHDL.tcl
-
-          namespace eval ::poc {
-            variable myConfigFile  "../tb/common/my_config_GENERIC.vhdl"
-            variable myProjectFile "../tb/common/my_project.vhdl"
-            variable vendor        "GENERIC";                               # GENERIC for vendor-less build; Xilinx, Altera,... for vendor specific build
-          }
-
-          set ::osvvm::AnalyzeErrorStopCount  1
-          SetExtendedAnalyzeOptions  {-frelaxed -Wno-specs}
-
-          build ../../src/PoC.pro PoC
-          EOF
-
-          printf "=================\n"
-          tclsh run.tcl
-
-      - name: 📈 Simulate PoC
-        run: |
-          cd temp/ghdl
-
-          tee run.tcl <<EOF
-          source ../../lib/OSVVM-Scripts/StartGHDL.tcl
-
-          namespace eval ::poc {
-            variable myConfigFile  "../tb/common/my_config_GENERIC.vhdl"
-            variable myProjectFile "../tb/common/my_project.vhdl"
-            variable vendor        "GENERIC";                               # GENERIC for vendor-less build; Xilinx, Altera,... for vendor specific build
-          }
-
-          SetExtendedSimulateOptions {-frelaxed -Wno-specs -Wno-binding}
-
-          build ../../tb/RunAllTests.pro
-          EOF
-
-          printf "=================\n"
-          tclsh run.tcl
-
-      - name: 📤 Upload 'GHDL-PoC-Report' artifacts
-        uses: pyTooling/upload-artifact@v4
+      - name: 🗑️ Delete YAML artifacts from matrix jobs
+        uses: geekyeggo/delete-artifact@v5
         continue-on-error: true
         with:
-          name: GHDL-PoC-Report
-          working-directory: temp/ghdl
-          path: |
-            logs
-            reports
-            *.html
-            *.yml
-          retention-days: 1
+          name: |
+            OSVVM-Report-YAML-*
+            PoC-Report-YAML-*
 
-      - name: 📤 Upload 'GHDL-PoC-Report-XML' artifacts
-        uses: pyTooling/upload-artifact@v4
+      - name: 🗑️ Delete JUnit XML artifacts from matrix jobs
+        uses: geekyeggo/delete-artifact@v5
         continue-on-error: true
         with:
-          name: GHDL-PoC-Report-XML
-          working-directory: temp/ghdl
-          path: |
-            *.xml
-          retention-days: 1
-
-      - name: 📤 Upload 'GHDL-PoC' artifacts
-        uses: pyTooling/upload-artifact@v4
-        with:
-          name: GHDL-PoC
-          working-directory: temp/ghdl
-          path: |
-            VHDL_LIBS
-          retention-days: 1
+          name: |
+            OSVVM-Report-XML-*
+            PoC-Report-XML-*
 
   Documentation:
-    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r4
+    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
     needs:
-      - Build-PoC
+      - PublishTestResults
+#    if: success() || failure()
     with:
       requirements:          '-r docs/requirements.txt'
       doc_directory:         'docs'
-      unittest_xml_artifact: 'GHDL-PoC-Report-XML'
+      unittest_xml_artifact: 'PoC-Report-XML'
       html_artifact:         'PoC-HTML'
       latex_artifact:        'PoC-LaTeX'
 
+  Test:
+    runs-on: 'ubuntu-24.04'
+    needs:
+      - Simulate
+      - PublishTestResults
+      - Documentation
+#    if: success() || failure()
+    steps:
+      - run: |
+          printf "Simulate:           '%s'\n" "${{ needs.Simulate.result }}"
+          printf "PublishTestResults: '%s'\n" "${{ needs.PublishTestResults.result }}"
+          printf "Documentation:      '%s'\n" "${{ needs.Documentation.result }}"
+
+  PDFDocumentation:
+    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
+    needs:
+      - Documentation
+    if: (success() || failure()) && needs.Documentation.result == 'success'
+    with:
+      document:       'The PoC-Library'
+      latex_artifact: 'PoC-LaTeX'
+      pdf_artifact:   'PoC-PDF'
+      can-fail:       'true'
+
   PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
     needs:
       - Documentation
-      - Build-PoC
+      - Simulate
+#    if: (success() || failure()) && needs.Documentation.result == 'success'
     with:
       doc:      'PoC-HTML'
 #      coverage: 'PoC-Coverage-HTML'
 
+  AutoTag:
+    uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@r6
+    needs:
+      - Prepare
+      - PublishToGitHubPages
+    if: needs.Prepare.outputs.is_release_commit == 'true' && github.event_name != 'schedule'
+    permissions:
+      contents: write  # required for create tag
+      actions:  write  # required for trigger workflow
+    with:
+      version:  ${{ needs.Prepare.output.version }}
+      auto_tag: ${{ needs.Prepare.outputs.is_release_commit }}
+
   Release:
-    uses: pyTooling/Actions/.github/workflows/NightlyRelease.yml@r4
-    if: startsWith(github.ref, 'refs/tags/v')
+    uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r6
     needs:
-#      - Ubuntu
-#      - Windows
-#      - PublishCoverageResults
-#      - PublishTestResults
       - PublishToGitHubPages
-    secrets: inherit
+    if: needs.Prepare.outputs.is_release_tag == 'true'
     permissions:
       contents: write
-      actions: write
-      attestations: write
+      actions:  write
     with:
       prerelease: true
       replacements: |
-        poc=1.3.0
-      nightly_name: "v1.3.0"
-      nightly_description: |
+        poc=${{ needs.Prepare.outputs.version }}
+      tag: ${{ needs.Prepare.outputs.version }}
+      description: |
         # The PoC-Library %poc%
       inventory-json: "inventory.json"
-      inventory-version: "1.3.0"
+      inventory-version: ${{ needs.Prepare.outputs.version }}
       assets: |
+
+    secrets: inherit