ci/docs: Update CI workflows, toolchain, and environment setup

moidx · moidx · commit ee16ce3e804e · 2026-02-20T04:23:46.000Z
This commit consolidates updates for:
- Updating all GitHub Actions to actions/checkout@v4 for Node.js 20 support.
- Adding Ubuntu Noble repository to CI for newer RISC-V toolchain (GCC 13) with rv32imc multilib support.
- Adding Python environment setup instructions (venv/Conda) to README.md.
- Creating a top-level requirements.txt to centralize all project dependencies.

Signed-off-by: Miguel Osorio &lt;miguelosorio@google.com&gt;
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -15,7 +15,7 @@ jobs:
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
             python3 python3-pip
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Build Docs
         run: |
           pushd docs
diff --git a/.github/workflows/custom-lint.yml b/.github/workflows/custom-lint.yml
@@ -15,7 +15,7 @@ jobs:
       GHA_EXTERNAL_DISK: additional-tools-all
       GHA_SA: gh-sa-veer-uploader
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/gh-pages-pr-remove.yml b/.github/workflows/gh-pages-pr-remove.yml
@@ -19,7 +19,7 @@ jobs:
       contents: write
     steps:
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install coverage dependencies
         run: |
@@ -29,7 +29,7 @@ jobs:
           echo "PATH=$PATH" >> $GITHUB_ENV
 
       - name: Download deployment
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: gh-pages
           path: ${{ env.ROOT_DIR }}
diff --git a/.github/workflows/publish-webpage.yml b/.github/workflows/publish-webpage.yml
@@ -15,7 +15,7 @@ jobs:
       contents: write
     steps:
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Print metadata
         run: |
@@ -55,7 +55,7 @@ jobs:
           path: ./riscof_dashboard
 
       - name: Checkout gh-pages
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: gh-pages
           path: ./public.checkout
diff --git a/.github/workflows/report-coverage.yml b/.github/workflows/report-coverage.yml
@@ -15,7 +15,7 @@ jobs:
     env:
       DEBIAN_FRONTEND: "noninteractive"
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -59,7 +59,7 @@ jobs:
       GHA_SA: gh-sa-veer-uploader
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -93,7 +93,7 @@ jobs:
       GHA_SA: gh-sa-veer-uploader
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-openocd.yml b/.github/workflows/test-openocd.yml
@@ -24,6 +24,7 @@ jobs:
     steps:
       - name: Install utils
         run: |
+          echo "deb http://archive.ubuntu.com/ubuntu/ noble main universe" | sudo tee -a /etc/apt/sources.list > /dev/null
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
              ccache ninja-build gcc-riscv64-unknown-elf
           pip3 install meson
@@ -44,7 +45,7 @@ jobs:
           echo "cache_test_key=$cache_test_key" | tee -a "$GITHUB_ENV"
 
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -117,7 +118,7 @@ jobs:
       GHA_EXTERNAL_DISK: additional-tools
       GHA_SA: gh-sa-veer-uploader
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-regression-cache-waypack.yml b/.github/workflows/test-regression-cache-waypack.yml
@@ -54,13 +54,14 @@ jobs:
     steps:
       - name: Install utils
         run: |
+          echo "deb http://archive.ubuntu.com/ubuntu/ noble main universe" | sudo tee -a /etc/apt/sources.list > /dev/null
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
             git python3 python3-pip build-essential ninja-build ccache \
             gcc-riscv64-unknown-elf
           pip3 install meson
 
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -141,7 +142,7 @@ jobs:
       GHA_EXTERNAL_DISK: additional-tools
       GHA_SA: gh-sa-veer-uploader
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-regression-dcls.yml b/.github/workflows/test-regression-dcls.yml
@@ -52,13 +52,14 @@ jobs:
     steps:
       - name: Install utils
         run: |
+          echo "deb http://archive.ubuntu.com/ubuntu/ noble main universe" | sudo tee -a /etc/apt/sources.list > /dev/null
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
             git python3 python3-pip build-essential ninja-build ccache \
             gcc-riscv64-unknown-elf
           pip3 install meson
 
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -117,7 +118,7 @@ jobs:
       GHA_EXTERNAL_DISK: additional-tools
       GHA_SA: gh-sa-veer-uploader
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-regression-exceptions.yml b/.github/workflows/test-regression-exceptions.yml
@@ -30,13 +30,14 @@ jobs:
     steps:
       - name: Install utils
         run: |
+          echo "deb http://archive.ubuntu.com/ubuntu/ noble main universe" | sudo tee -a /etc/apt/sources.list > /dev/null
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
             git python3 python3-pip build-essential ninja-build ccache \
             gcc-riscv64-unknown-elf
           pip3 install meson
 
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -86,7 +87,7 @@ jobs:
       GHA_EXTERNAL_DISK: additional-tools
       GHA_SA: gh-sa-veer-uploader
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-renode.yml b/.github/workflows/test-renode.yml
@@ -19,6 +19,7 @@ jobs:
 
       - name: Install dependencies
         run: |
+          echo "deb http://archive.ubuntu.com/ubuntu/ noble main universe" | sudo tee -a /etc/apt/sources.list > /dev/null
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
             git python3 python3-pip build-essential ninja-build ccache \
             gcc-riscv64-unknown-elf
diff --git a/.github/workflows/test-riscof.yml b/.github/workflows/test-riscof.yml
@@ -38,7 +38,7 @@ jobs:
           riscv64-unknown-elf-gcc --version
 
       - name: Setup repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-riscv-dv.yml b/.github/workflows/test-riscv-dv.yml
@@ -63,7 +63,7 @@ jobs:
       GHA_EXTERNAL_DISK: additional-tools
       CACHE_HASH: ${{ needs.generate-config.outputs.hash }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -142,7 +142,7 @@ jobs:
           riscv64-unknown-elf-gcc --version
 
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -239,7 +239,7 @@ jobs:
       CACHE_HASH: ${{ needs.generate-config.outputs.hash }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-uarch.yml b/.github/workflows/test-uarch.yml
@@ -14,7 +14,7 @@ jobs:
     container: ghcr.io/antmicro/cores-veer-el2:20250411084921
     steps:
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -93,7 +93,7 @@ jobs:
       DEBIAN_FRONTEND: "noninteractive"
     steps:
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -106,6 +106,7 @@ jobs:
 
       - name: Install prerequisites
         run: |
+          echo "deb http://archive.ubuntu.com/ubuntu/ noble main universe" | sudo tee -a /etc/apt/sources.list > /dev/null
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
             autoconf automake autotools-dev \
             bc bison build-essential \
@@ -218,7 +219,7 @@ jobs:
       GHA_SA: gh-sa-veer-uploader
       TEST: ${{ matrix.test }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-uvm.yml b/.github/workflows/test-uvm.yml
@@ -13,7 +13,7 @@ jobs:
       DEBIAN_FRONTEND: "noninteractive"
     steps:
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/test-verification.yml b/.github/workflows/test-verification.yml
@@ -23,7 +23,7 @@ jobs:
       FULL_NAME: "${{ matrix.bus }}-verification-${{ matrix.test }}"
     steps:
       - name: Setup repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -35,6 +35,7 @@ jobs:
 
       - name: Install prerequisities
         run: |
+          echo "deb http://archive.ubuntu.com/ubuntu/ noble main universe" | sudo tee -a /etc/apt/sources.list > /dev/null
           sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
             autoconf automake autotools-dev \
             bc bison build-essential \
@@ -124,7 +125,7 @@ jobs:
       GHA_EXTERNAL_DISK: additional-tools
       GHA_SA: gh-sa-veer-uploader
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
diff --git a/.github/workflows/verible-format.yml b/.github/workflows/verible-format.yml
@@ -11,7 +11,7 @@ jobs:
       contents: read
       pull-requests: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - uses: antmicro/verible-formatter-action@update-upload-action
diff --git a/.github/workflows/verible-lint.yml b/.github/workflows/verible-lint.yml
@@ -11,7 +11,7 @@ jobs:
       contents: read
       pull-requests: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - uses: chipsalliance/verible-linter-action@main
diff --git a/README.md b/README.md
@@ -42,8 +42,37 @@ Files under the [tools](tools/) directory may be available under a different lic
 
 - Verilator **(4.106 or later)** must be installed on the system if running with Verilator
 - If adding/removing instructions, [`espresso`](https://github.com/chipsalliance/espresso/tree/master) must be installed (used by `tools/coredecode`). Remember to checkout on `3.x` branch.
-- RISCV tool chain (based on gcc version 8.3 or higher) must be
-installed so that it can be used to prepare RISCV binaries to run.
+- RISCV tool chain (based on gcc version 8.3 or higher) must be installed so that it can be used to prepare RISCV binaries to run.
+- [**Verible**](https://github.com/chipsalliance/verible) is used for SystemVerilog linting and formatting.
+- **Python 3.10+** is required for verification, documentation, and linting.
+
+### Python Environment Setup
+
+It is recommended to use a virtual environment (venv) or Conda to manage Python dependencies.
+
+#### Using `venv`
+```bash
+# Create a virtual environment
+python3 -m venv .venv
+
+# Activate it
+source .venv/bin/activate
+
+# Install all project dependencies
+pip install -r requirements.txt
+```
+
+#### Using `Conda`
+```bash
+# Create a conda environment
+conda create -n veer-el2 python=3.12
+
+# Activate it
+conda activate veer-el2
+
+# Install dependencies
+pip install -r requirements.txt
+```
 
 ## Quickstart guide
 
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,31 @@
+# Build and Workflow Tools
+nox
+meson
+
+# Linters
+isort
+black
+flake8
+
+# Documentation
+Sphinx>=8.0.2,<9
+# Sphinx utilities
+https://github.com/antmicro/antmicro-sphinx-utils/archive/main.zip
+
+# Verification - Core
+# Note: Custom cocotb might be required for some flows
+# ./third_party/cocotb
+cocotb==1.8.0
+cocotb-bus==0.2.1
+cocotb-coverage==1.1.0
+cocotb-test==0.2.4
+pyuvm==2.9.1
+
+# Verification - Testing & Reporting
+pytest==7.4.1
+pytest-html==3.2.0
+pytest-timeout==2.1.0
+pytest-md==0.2.0
+
+# Scientific/Math (used in some block tests)
+scipy==1.13.1
