GitHub Actions에서 svlint 실행

소개

쓰레기 코드 생산자를 매달아 올린다 코딩 룰의 중요성을 계몽하기 위해서는, 코딩 룰에 준거하고 있거나, 린트 체크를 높은 빈도로 실시하는 것이 중요합니다.

svlint 을 사용하면, RTL 등 SystemVerilog 로 쓰여진 소스 코드의 린트 체크를 실시할 수가 있습니다. GitHub Actions를 사용하여 푸시시 자동으로 린트 체크를 실행할 수 있도록 해 보았습니다.

설정 방법

하는 것은 쉽습니다. .github/workflows 에 실행하고 싶은 처리의 흐름을 쓴 YAML 를 두는 것 뿐입니다. 저자 근제의 svlint 용 Action이 공개되어 있습니다. 이렇게하면 GitHub Actions에서 svlint를 쉽게 실행할 수 있습니다.

예를 들어, 필자가 사용하고 있는 YAML 파일을 올려 놓습니다.

name: svlint

on: [push, pull_request]

jobs:
  svlint:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Run svlint
        uses: dalance/svlint-action@v1
        with:
          filelists: |
            rtl/common/compile.f
            rtl/router/compile.f
            rtl/fabric/compile.f
            rtl/axi_adapter/compile.f
        env:
          TNOC_HOME: ${{ github.workspace }}

실행 예

위의 YAML을 GitHub 리포지토리에 놓으면 푸시 또는 풀 요청이 열릴 때 자동으로 svlint를 실행하여 린트 검사를 수행 할 수 있습니다. 소스 코드에 부적절한 설명이 있으면 다음과 같이 지적되어 GitHub의 알림 필드에도 알립니다.