Add flow to generate markdown from testplans

Author: robertszczepanski

.github/workflows/build-docs.yml

@@ -22,6 +22,12 @@ jobs:
       - name: Setup repository
         uses: actions/checkout@v4
 
+      - name: Generate VP
+        run: |
+          export I3C_ROOT_DIR="`pwd`"
+          pip3 install git+https://github.com/antmicro/testplanner.git
+          make verification-docs
+
       - name: Build Docs
         run: |
           pushd testplans-template

Makefile

@@ -15,6 +15,7 @@ BLOCK_VERIF_DIR     := $(COCOTB_VERIF_DIR)/block
 TOP_VERIF_DIR       := $(COCOTB_VERIF_DIR)/top
 TOOL_VERIF_DIR      := $(VERIFICATION_DIR)/tools/
 UVM_VERIF_DIR       := $(VERIFICATION_DIR)/uvm_i3c/
+TESTPLAN_DIR        := $(VERIFICATION_DIR)/testplan
 
 TOOL_DIR            := $(I3C_ROOT_DIR)/tools/
 UVM_TOOL_DIR        := $(TOOL_DIR)/uvm/
@@ -132,6 +133,10 @@ tests-uvm-debug: config ## Run debugging I3C Core UVM tests with nox
 tests-tool: ## Run all tool tests
 	cd $(TOOL_VERIF_DIR) && $(PYTHON) -m nox -k "verify" --no-venv
 
+VERIFICATION_PLANS = $(shell find $(TESTPLAN_DIR) -type f -name "*.hjson" -printf "%P\n")
+verification-docs:
+	cd $(TESTPLAN_DIR) && testplanner $(VERIFICATION_PLANS) -o $(TESTPLAN_DIR)/generated
+
 #
 # Utilities
 #

requirements.txt

@@ -11,6 +11,7 @@ cocotb-coverage==1.2.0
 cocotb-test==0.2.5
 cocotbext-axi==0.1.24
 -e git+https://github.com/alexforencich/cocotbext-i2c@3b32eedc15302f1299a23bb35aa669fffad2ca22#egg=cocotbext_i2c
+git+https://github.com/antmicro/testplanner.git@bbf374a
 -e ${I3C_ROOT_DIR}/third_party/cocotbext-i3c
 -e ${I3C_ROOT_DIR}/tools/nox_utils
 -e ${I3C_ROOT_DIR}/tools/cocotb_helpers