README.md

Verilog Cleaner

Introduction

This action lints and formats Verilog code by running Verilator and Verible and outputs its findings with reviewdog through GitHub APIs such as GitHub Checks.

Inputs

github_token

required The secret token for authenticating action work.

A good choice is to just input ${{ secrets.GITHUB_TOKEN }}.

workdir

optional The action working directory, relative to ${GITHUB_WORKSPACE}.

Defaults to root directory of repository (.).

reporter

optional A comprehensive list of reporters can be found here.

Defaults to github-check.

Minimal Example

on: [push]

jobs:
  clean-verilog:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2 # Checkout source
    - uses: reviewdog/action-setup@v1 # Setup reviewdog
    - uses: SuibianP/verilog-cleaner@v1 # lint and format
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
    - uses: peter-evans/create-pull-request@v3 # Creates pull request with formatting results
      with:
        delete-branch: true

Assumptions and Limitations

This action assumes that the host OS is Ubuntu, with docker and reviewdog installed. Other POSIX OSes/compatible layers can also be quite easily supported but I have neither the time nor a testing machine for those. Therefore, I will just hope for a miraculously incoming pull request someday.

Hilarious Thing?

I actually accidentally overwritten my /bin and /share directories with tar when I was testing this script LOL 🤣 A close try to rm -rf /!