hw_linting.yaml

name: RTL Linting

on: push

jobs:
  changes:
    uses: ./.github/workflows/filter.yaml

  lint-python:
    needs: changes
    if: ${{ needs.changes.outputs.hardware == 'true' }}
    name: Linting Python with PyLint
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - name: Set up Python 3.7
        uses: actions/setup-python@v2
        with:
          python-version: 3.7
      - name: Lint with pylint
        run: |
          $CONDA/bin/conda install -c conda-forge pylint=2.17.1
          $CONDA/bin/pylint --reports yes hardware/util/* hardware/target/dv/**/*.py hardware/analysis/*.py

  typechecking-python:
    needs: changes
    if: ${{ needs.changes.outputs.algorithmic == 'true' }}
    runs-on: ubuntu-latest
    container: # use gpu env as mypy does not work in hw env
      image: ghcr.io/joennlae/halutmatmul-conda-gpu:latest
    defaults:
      run:
        shell: bash -el {0}
    steps:
      - uses: actions/checkout@v3
      - name: Check types with mypy
        run: |
          source /venv/bin/activate
          mypy hardware/util hardware/target/dv/**/*.py

  hw-lint-verilator:
    needs: changes
    if: ${{ needs.changes.outputs.hardware == 'true' }}
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/joennlae/halutmatmul-conda-hw:latest
    defaults:
      run:
        shell: bash -el {0}
    steps:
      - uses: actions/checkout@v3
      - name: Lint RTL with verilator
        run: |
          source /venv/bin/activate
          cd hardware
          make halut-lint-verilator

  hw-lint-verilate:
    needs: changes
    if: ${{ needs.changes.outputs.hardware == 'true' }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run Verible
        uses: chipsalliance/verible-linter-action@main
        with:
          paths: hardware/rtl
          extra_args: "--waiver_files .github/verible.waiver"
          github_token: ${{ secrets.GITHUB_TOKEN }}
          fail_on_error: true
          reviewdog_reporter: github-check