verilator/.github/workflows/build.yml

# DESCRIPTION: Github actions config
# This name is key to badges in README.rst, so we use the name build
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0

name: build

on:
  push:
  pull_request:
  workflow_dispatch:
  schedule:
  - cron: '0 0 * * 0' # weekly

env:
  CI_OS_NAME: linux
  CI_COMMIT: ${{ github.sha }}
  CCACHE_COMPRESS: 1
  CCACHE_DIR: ${{ github.workspace }}/.ccache
  CCACHE_LIMIT_MULTIPLE: 0.95

jobs:


  Matrix:
    runs-on: ubuntu-latest
    name: Generate Build matrix
    outputs:
      matrix: ${{ steps.generate.outputs.matrix }}
    steps:
    - uses: actions/checkout@v2
    - id: generate
      name: Run 'generate_matrix.sh'
      run: |
        if [ '${{ github.event_name }}' = 'pull_request' ]; then
          matrix='[ "ubuntu-20.04" ]'
        else
          matrix='[ "ubuntu-16.04", "ubuntu-18.04", "ubuntu-20.04" ]'
        fi
        echo "::set-output name=matrix::$matrix"        


  Build:
    needs: Matrix
    strategy:
      fail-fast: false
      matrix:
        os: ${{ fromJson(needs.Matrix.outputs.matrix) }}
        target:
          - { name: opt, ccache_size: 48M  }
          - { name: dbg, ccache_size: 208M }
        compiler:
          - { cc: clang, cxx: clang++ }
          - { cc: gcc,   cxx: g++     }
    runs-on: ${{ matrix.os }}
    name: Build | ${{ matrix.os }} | ${{ matrix.compiler.cc }} | ${{ matrix.target.name }}
    env:
      CI_BUILD_STAGE_NAME: build
      CI_RUNS_ON: ${{ matrix.os }}
      CI_MAKE_SRC_TARGET: ${{ matrix.target.name }}
      CC: ${{ matrix.compiler.cc }}
      CXX: ${{ matrix.compiler.cxx }}
      CACHE_BASE_KEY: build-${{ matrix.os }}-${{ matrix.compiler.cc }}-${{ matrix.target.name }}
      CCACHE_MAXSIZE: ${{ matrix.target.ccache_size }} # Per build matrix entry (1G in total)
      VERILATOR_ARCHIVE: verilator-${{ github.sha }}-${{ matrix.os }}-${{ matrix.compiler.cc }}-${{ matrix.target.name }}.tar.gz
    steps:

    - name: Checkout
      uses: actions/checkout@v2

    - name: Cache $CCACHE_DIR
      uses: actions/cache@v2
      env:
        CACHE_KEY: ${{ env.CACHE_BASE_KEY }}-ccache
      with:
        path: ${{ env.CCACHE_DIR }}
        key: ${{ env.CACHE_KEY }}-${{ github.sha }}
        restore-keys: |
          ${{ env.CACHE_KEY }}-          

    - name: Install packages for build
      run: ./ci/ci-install.bash

    - name: Build
      run: |
        ccache -z
        ./ci/ci-script.bash
        ccache -s
        tar cvzf ${{ env.VERILATOR_ARCHIVE }} bin        

    - name: Upload Verilator artifact
      uses: actions/upload-artifact@v2
      with:
        name: ${{ env.VERILATOR_ARCHIVE }}
        path: ${{ env.VERILATOR_ARCHIVE }}


  Test:
    needs: [ Matrix, Build ]
    strategy:
      fail-fast: false
      matrix:
        os: ${{ fromJson(needs.Matrix.outputs.matrix) }}
        compiler:
          - { cc: clang, cxx: clang++ }
          - { cc: gcc,   cxx: g++     }
        suite:
          - dist-vlt-0
          - dist-vlt-1
          - dist-vlt-2
          - vltmt-0
          - vltmt-1
    runs-on: ${{ matrix.os }}
    name: Test | ${{ matrix.os }} | ${{ matrix.compiler.cc }} | ${{ matrix.suite }}
    env:
      CI_BUILD_STAGE_NAME: test
      CI_RUNS_ON: ${{ matrix.os }}
      CC: ${{ matrix.compiler.cc }}
      CXX: ${{ matrix.compiler.cxx }}
      CACHE_BASE_KEY: test-${{ matrix.os }}-${{ matrix.compiler.cc }}-${{ matrix.suite }}
      CCACHE_MAXSIZE: 64M # Per build matrix entry (1920M in total)
      VERILATOR_ARCHIVE_BASE: verilator-${{ github.sha }}-${{ matrix.os }}-${{ matrix.compiler.cc }}
    steps:

    - name: Checkout
      uses: actions/checkout@v2

    - name: Cache $CCACHE_DIR
      uses: actions/cache@v2
      env:
        CACHE_KEY: ${{ env.CACHE_BASE_KEY }}-ccache
      with:
        path: ${{ env.CCACHE_DIR }}
        key: ${{ env.CACHE_KEY }}-${{ github.sha }}
        restore-keys: |
          ${{ env.CACHE_KEY }}-          

    - name: Download Verilator artifact (opt)
      uses: actions/download-artifact@v2
      with:
        name: ${{ env.VERILATOR_ARCHIVE_BASE }}-opt.tar.gz

    - name: Download Verilator artifact (dbg)
      uses: actions/download-artifact@v2
      with:
        name: ${{ env.VERILATOR_ARCHIVE_BASE }}-dbg.tar.gz

    - name: Unpack Verilator artifacts
      run: |
        tar xvzf ${{ env.VERILATOR_ARCHIVE_BASE }}-opt.tar.gz
        tar xvzf ${{ env.VERILATOR_ARCHIVE_BASE }}-dbg.tar.gz        

    - name: Install test dependencies
      run: |
        ./ci/ci-install.bash        

    - name: Test
      env:
        TESTS: ${{ matrix.suite }}
      run: |
        ccache -z
        ./ci/ci-script.bash
        ccache -s