Major updates towards v1.3.0

.github/issue_template/Feature Request.md

@@ -0,0 +1,31 @@
+# Problem and/or Feature Description 
+<!--
+Is your feature request related to a problem?
+Please describe.
+-->
+
+> [!NOTE]
+> Add a clear and concise description of what the problem is.  
+
+
+# Suggested Solution
+<!--
+Describe the solution you'd like.
+-->
+
+> [!NOTE]
+> Add a clear and concise description of what you want to happen.
+
+# Alternatives
+<!--
+Describe alternatives you've considered.
+-->
+
+> [!TIP]
+> Add a clear and concise description of any alternative solutions
+> or features you've considered.
+
+# Additional context
+
+> [!TIP]
+> Add any other context or screenshots about the feature request here.

.github/issue_template/Problem Report.md

@@ -0,0 +1,62 @@
+<!--
+We do not consider any issue immediately a bug.
+In any case, an issue is a deviation from an expected
+behavior. Therefore, we write a problem description.
+Then the problem is investigated and either it's a bug
+or a misunderstanding/misinterpretation.
+-->
+
+# Problem
+<!--
+What diverging behavior was observed? Please describe
+the behavior and how to reproduce.
+-->
+
+> [!NOTE]
+> Write problem description here.
+
+
+# Root Cause
+<!--
+What is the root cause? This may need further investigation
+before agreeing on a final solution.
+-->
+
+> [!TIP]
+> Write root cause description here.
+> 
+> Might be filled in after investigation.
+
+
+# Solution
+<!--
+Solution to (finally) solve the problem in a new revision.
+-->
+
+> [!TIP]
+> Write solution description here.
+> 
+> If possible propose a solution.  
+> Might be filled in after investigation and root cause detection.
+
+
+# Workaround
+<!--
+Intermediate solution (workaround), if even possible.
+-->
+
+> [!TIP]
+> Write workaround description here.
+> 
+> If possible propose a workaround.    
+> Might be filled in after investigation.
+
+
+## Actions
+<!--
+Proposed next steps to either narrow down the problem, develop
+a workaround or to sketch a workaround.
+-->
+
+1. {-fill out-}
+1. {-fill out-}

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+# New Features
+
+* tbd
+* tbd
+
+# Changes
+
+* tbd
+* tbd
+
+# Bug Fixes
+
+* tbd
+* tbd
+
+# Documentation
+
+* tbd
+* tbd
+
+# Tests
+
+* tbd
+* tbd
+
+----------
+# Related Issues and Pull-Requests
+
+* tbd
+* tbd

.github/workflows/Pipeline.yml

@@ -0,0 +1,235 @@
+name: Verify PoC and Generate Documentation
+
+on:
+  push:
+  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
+    needs:
+      - Build-OSVVM
+    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
+        continue-on-error: true
+        with:
+          name: GHDL-PoC-Report
+          working-directory: temp/ghdl
+          path: |
+            logs
+            reports
+            *.html
+            *.yml
+          retention-days: 1
+
+      - name: 📤 Upload 'GHDL-PoC-Report-XML' artifacts
+        uses: pyTooling/upload-artifact@v4
+        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
+
+  Documentation:
+    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r4
+    needs:
+      - Build-PoC
+    with:
+      requirements:          '-r docs/requirements.txt'
+      doc_directory:         'docs'
+      unittest_xml_artifact: 'GHDL-PoC-Report-XML'
+      html_artifact:         'PoC-HTML'
+      latex_artifact:        'PoC-LaTeX'
+
+  PublishToGitHubPages:
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
+    needs:
+      - Documentation
+      - Build-PoC
+    with:
+      doc:      'PoC-HTML'
+#      coverage: 'PoC-Coverage-HTML'
+
+  Release:
+    uses: pyTooling/Actions/.github/workflows/NightlyRelease.yml@r4
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs:
+#      - Ubuntu
+#      - Windows
+#      - PublishCoverageResults
+#      - PublishTestResults
+      - PublishToGitHubPages
+    secrets: inherit
+    permissions:
+      contents: write
+      actions: write
+      attestations: write
+    with:
+      prerelease: true
+      replacements: |
+        poc=1.3.0
+      nightly_name: "v1.3.0"
+      nightly_description: |
+        # The PoC-Library %poc%
+      inventory-json: "inventory.json"
+      inventory-version: "1.3.0"
+      assets: |