ci.yml

name: VeeR-EL2 CI

on:
  push:
    branches: ["main"]
  pull_request:
  workflow_dispatch:
  schedule:
    - cron: '0 2 * * *' # run daily at 02:00 am (UTC)

jobs:

  Check-PR-Origin:
    name: Check PR origin
    runs-on: ubuntu-24.04
    outputs:
      is_internal: ${{ steps.check.outputs.is_internal }}
    steps:
      - name: Determine if PR is from chipsalliance organization
        id: check
        env:
          EVENT_NAME: ${{ github.event_name }}
          HEAD_REPO_OWNER: ${{ github.event.pull_request.head.repo.owner.login }}
        run: |
          if [ "$EVENT_NAME" != "pull_request" ]; then
            echo "is_internal=true" >> $GITHUB_OUTPUT
            echo "Not a pull request event. Custom CI checks will run."
          elif [ "$HEAD_REPO_OWNER" = "chipsalliance" ]; then
            echo "is_internal=true" >> $GITHUB_OUTPUT
            echo "PR from chipsalliance organization. Custom CI checks will run."
          else
            echo "is_internal=false" >> $GITHUB_OUTPUT
            echo "PR from external fork ($HEAD_REPO_OWNER). Custom CI checks will be skipped."
          fi

  # Public tests (all start immediately, GitHub-hosted runners)

  Test-DCLS:
    name: Test-DCLS-Regression
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-dcls.yml
    with:
      run_public: true
      run_custom: false

  Test-Regression-Cache-Waypack-0-num-ways-2:
    name: Test-Regression Cache Waypack 0 Num Ways 2
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 0
      num_ways: 2
      run_public: true
      run_custom: false

  Test-Regression-Cache-Waypack-0-num-ways-4:
    name: Test-Regression Cache Waypack 0 Num Ways 4
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 0
      num_ways: 4
      run_public: true
      run_custom: false

  Test-Regression-Cache-Waypack-1-num-ways-2:
    name: Test-Regression Cache Waypack 1 Num Ways 2
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 1
      num_ways: 2
      run_public: true
      run_custom: false

  Test-Regression-Cache-Waypack-1-num-ways-4:
    name: Test-Regression Cache Waypack 1 Num Ways 4
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 1
      num_ways: 4
      run_public: true
      run_custom: false

  Test-Exceptions-Regression:
    name: Test-Exceptions-Regression
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-exceptions.yml
    with:
      run_public: true
      run_custom: false

  Test-Verification:
    name: Test-Verification
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-verification.yml
    with:
      run_public: true
      run_custom: false

  Test-Microarchitectural:
    name: Test-Microarchitectural
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-uarch.yml
    with:
      run_public: true
      run_custom: false

  Test-OpenOCD:
    name: Test-OpenOCD
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-openocd.yml
    with:
      run_public: true
      run_custom: false

  Test-RISCOF:
    name: Test-RISCOF
    uses: ./.github/workflows/test-riscof.yml

  Test-UVM:
    name: Test-UVM
    uses: ./.github/workflows/test-uvm.yml

  Test-Renode:
    name: Test-Renode
    uses: ./.github/workflows/test-renode.yml

  # Custom: immediate starters (self-hosted runners)
  # PMP-Random and OpenOCD (JTAG) are long-running; they start immediately and
  # run in parallel with all subsequent waves without gating any of them.
  # Exceptions also starts immediately and acts as the gate for Wave 2.

  Custom-PMP-Random:
    name: Custom PMP Random tests
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-uarch.yml
    with:
      run_public: false
      run_custom: true
      run_pmp_random: true

  Custom-Regression-Cache-Waypack-PMP-Random:
    name: Custom Cache Waypack PMP Random tests
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-cache-waypack-pmp-random.yml
    with:
      run_custom: true

  Custom-OpenOCD:
    name: Custom OpenOCD (JTAG) tests
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-openocd.yml
    with:
      run_public: false
      run_custom: true

  Custom-Exceptions:
    name: Custom Exceptions Regression
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin]
    uses: ./.github/workflows/test-regression-exceptions.yml
    with:
      run_public: false
      run_custom: true

  # Custom Wave 2: Cache Waypack 0 (after Exceptions)

  Custom-Regression-Cache-Waypack-0-num-ways-2:
    name: Custom Regression Cache Waypack 0 Num Ways 2
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin, Custom-Exceptions]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 0
      num_ways: 2
      run_public: false
      run_custom: true

  Custom-Regression-Cache-Waypack-0-num-ways-4:
    name: Custom Regression Cache Waypack 0 Num Ways 4
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin, Custom-Exceptions]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 0
      num_ways: 4
      run_public: false
      run_custom: true

  # Custom Wave 3: Cache Waypack 1 (after Waypack 0)

  Custom-Regression-Cache-Waypack-1-num-ways-2:
    name: Custom Regression Cache Waypack 1 Num Ways 2
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin, Custom-Regression-Cache-Waypack-0-num-ways-2, Custom-Regression-Cache-Waypack-0-num-ways-4]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 1
      num_ways: 2
      run_public: false
      run_custom: true

  Custom-Regression-Cache-Waypack-1-num-ways-4:
    name: Custom Regression Cache Waypack 1 Num Ways 4
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin, Custom-Regression-Cache-Waypack-0-num-ways-2, Custom-Regression-Cache-Waypack-0-num-ways-4]
    uses: ./.github/workflows/test-regression-cache-waypack.yml
    with:
      waypack: 1
      num_ways: 4
      run_public: false
      run_custom: true

  # Custom Wave 4: remaining tests (after Waypack 1)

  Custom-DCLS:
    name: Custom DCLS Regression
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin, Custom-Regression-Cache-Waypack-1-num-ways-2, Custom-Regression-Cache-Waypack-1-num-ways-4]
    uses: ./.github/workflows/test-regression-dcls.yml
    with:
      run_public: false
      run_custom: true

  Custom-Verification:
    name: Custom Verification tests
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin, Custom-Regression-Cache-Waypack-1-num-ways-2, Custom-Regression-Cache-Waypack-1-num-ways-4]
    uses: ./.github/workflows/test-verification.yml
    with:
      run_public: false
      run_custom: true

  Custom-Microarchitectural:
    name: Custom Microarchitectural tests
    if: needs.Check-PR-Origin.outputs.is_internal == 'true'
    needs: [Check-PR-Origin, Custom-Regression-Cache-Waypack-1-num-ways-2, Custom-Regression-Cache-Waypack-1-num-ways-4]
    uses: ./.github/workflows/test-uarch.yml
    with:
      run_public: false
      run_custom: true

  # RISCV-DV custom tests depend on public run-tests artifacts (generated by
  # the custom generate-code job internally), so they are kept as a combined
  # call. Placed in Wave 4 to avoid competing with earlier waves for runner slots.
  Test-RISCV-DV:
    name: Test-RISCV-DV
    needs: [Check-PR-Origin, Custom-Regression-Cache-Waypack-1-num-ways-2, Custom-Regression-Cache-Waypack-1-num-ways-4]
    uses: ./.github/workflows/test-riscv-dv.yml
    with:
      run_custom: ${{ needs.Check-PR-Origin.outputs.is_internal == 'true' }}

  # Coverage & publishing

  Report-Coverage:
    name: Report-Coverage
    if: always()
    needs: [
      Check-PR-Origin,
      Test-DCLS,
      Test-Regression-Cache-Waypack-0-num-ways-2,
      Test-Regression-Cache-Waypack-0-num-ways-4,
      Test-Regression-Cache-Waypack-1-num-ways-2,
      Test-Regression-Cache-Waypack-1-num-ways-4,
      Test-Exceptions-Regression,
      Test-Verification,
      Test-Microarchitectural,
      Test-RISCOF,
      Test-OpenOCD,
      Custom-PMP-Random,
      Custom-Regression-Cache-Waypack-PMP-Random,
      Custom-OpenOCD,
      Custom-Exceptions,
      Custom-Regression-Cache-Waypack-0-num-ways-2,
      Custom-Regression-Cache-Waypack-0-num-ways-4,
      Custom-Regression-Cache-Waypack-1-num-ways-2,
      Custom-Regression-Cache-Waypack-1-num-ways-4,
      Custom-DCLS,
      Custom-Verification,
      Custom-Microarchitectural,
      Test-RISCV-DV
    ]
    uses: ./.github/workflows/report-coverage.yml
    with:
      run_custom: ${{ needs.Check-PR-Origin.outputs.is_internal == 'true' }}

  Upload-PR-Info:
    name: Upload PR info
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-24.04
    needs: [Check-PR-Origin]
    steps:
      - name: Write PR info
        run: |
          echo "number=${{ github.event.number }}" >> pr_number.txt
      - name: Upload PR info
        uses: actions/upload-artifact@v4
        with:
          name: pr_number
          path: pr_number.txt

  Build-Docs:
    name: Build-Docs
    uses: ./.github/workflows/build-docs.yml

  Publish-to-GH-Pages:
    concurrency:
      group: concurrency-group-${{ github.repository }}-publish
      cancel-in-progress: false
    permissions:
      actions: write
      contents: write
    name: Publish-to-GH-Pages
    needs: [Check-PR-Origin, Report-Coverage, Build-Docs]
    uses: ./.github/workflows/publish-webpage.yml
    with:
      run_custom: ${{ needs.Check-PR-Origin.outputs.is_internal == 'true' }}