build-firmware.yml

name: 'build-firmware'
on:
  push:
    branches:
      - test-build
    tags:
      - maia-sdr-*

# TODO: refactor this as a workflow_call action

jobs:
  build-firmware:
    strategy:
      matrix:
        target: [pluto, plutoplus]
    name: Build firmware
    runs-on: [self-hosted, vivado]
    container:
      image: ghcr.io/maia-sdr/maia-sdr-devel:latest
      volumes:
        - vivado2022_2:/opt/Xilinx
      options: --user root
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: recursive
    - name: Build firmware
      # xsct, which is run by the make process, uses Xvfb, which usually needs a
      # connection to an X server (even though it is a CLI application). We run
      # Xvfb in the container to create a "fake" X session that makes xsct
      # happy.
      #
      # We cannot '.' the main settings.sh file for Vivado, because it uses
      # 'source' to run the sub-files, and we are not using bash. Instead, we
      # '.' each individual sub-file.
      #
      # ADI_IGNORE_VERSION_CHECK is required because we use Vivado 2022.2.2
      # instead of 2022.2.
      run: |
        . /opt/Xilinx/Vitis/2022.2/.settings64-Vitis.sh
        . /opt/Xilinx/Vivado/2022.2/.settings64-Vivado.sh
        . /opt/Xilinx/Vitis_HLS/2022.2/.settings64-Vitis_HLS.sh
        . /opt/rust/env
        export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin/:/usr/bin:/sbin:/bin:$PATH:/opt/oss-cad-suite/bin
        export PYTHONPATH=/usr/local/lib/python3.10/dist-packages
        apt-get update
        DEBIAN_FRONTEND=noninteractive apt-get install -y xvfb
        Xvfb :10 &
        export DISPLAY=:10
        export ADI_IGNORE_VERSION_CHECK=1
        export TARGET=${{matrix.target}}
        make
    - name: Upload artifacts
      uses: actions/upload-artifact@v3
      with:
        name: maia-sdr-${{matrix.target}}-firmware
        path: |
          build/*-fw-*.zip
          build/*-jtag-bootstrap-*.zip
          build/system_top.xsa
        if-no-files-found: error
    # The working directory in the self-hosted runner needs be cleaned before
    # building. We use if: ${{ always() }} to clean even if the build fails.
    - name: Clean up runner working dir
      uses: TooMuch4U/actions-clean@v2.1
      if: ${{ always() }}