Verible Lint Action
Usage
See action.yml
This is a GitHub Action used to lint Verilog and SystemVerilog source files and comment erroneous lines of code in Pull Requests automatically. The GitHub Token input is used to provide reviewdog access to the PR. If you don't wish to use the automatic PR review, you can omit the github_token input. If you'd like to use a reporter of reviewdog other than github-pr-review, you can pass its name in the input reviewdog_reporter.
Here's a basic example to lint all *.v and *.sv files:
name: Verible linter example
on:
pull_request:
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: chipsalliance/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
You can provide optional arguments to specify paths, exclude paths, a config file and extra arguments for verible-verilog-lint.
- uses: chipsalliance/[email protected]
with:
config_file: 'config.rules'
paths: |
./rtl
./shared
exclude_paths: |
./rtl/some_file
extra_args: "--check_syntax=true"
github_token: ${{ secrets.GITHUB_TOKEN }}
Automatic review on PRs from external repositories
In GitHub Actions, workflows triggered by external repositories may only have read access to the main repository. In order to have automatic reviews on external PRs, you need to create two workflows. One will be triggered on pull_request and upload the data needed by reviewdog as an artifact. The artifact shall store the file pointed by $GITHUB_EVENT_PATH as event.json. The other workflow will download the artifact and use the Verible action.
For example:
name: upload-event-file
on:
pull_request:
...
- run: cp "$GITHUB_EVENT_PATH" ./event.json
- name: Upload event file as artifact
uses: actions/[email protected]
with:
name: event.json
path: event.json
name: review-triggered
on:
workflow_run:
workflows: ["upload-event-file"]
types:
- completed
jobs:
review_triggered:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- name: 'Download artifact'
id: get-artifacts
uses: actions/[email protected]
with:
script: |
var artifacts = await github.actions.listWorkflowRunArtifacts({
owner: context.repo.owner,
repo: context.repo.repo,
run_id: ${{github.event.workflow_run.id }},
});
var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
return artifact.name == "event.json"
})[0];
var download = await github.actions.downloadArtifact({
owner: context.repo.owner,
repo: context.repo.repo,
artifact_id: matchArtifact.id,
archive_format: 'zip',
});
var fs = require('fs');
fs.writeFileSync('${{github.workspace}}/event.json.zip', Buffer.from(download.data));
- run: |
unzip event.json.zip
- name: Run Verible action with Reviewdog
uses: chipsalliance/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
10 Dec 30, 2022
2 Jan 05, 2022
2 Jan 02, 2022
39 Jan 04, 2023
0 Dec 23, 2021
13 Nov 23, 2022
1 Apr 15, 2022
6 May 16, 2022
421 Jan 05, 2023
9 Jan 27, 2022
6 Dec 19, 2021
3 Aug 27, 2022
47 Oct 31, 2022
0 Jan 20, 2022
96 Dec 16, 2022
2 Dec 16, 2022
8 Jan 01, 2022
4 Aug 04, 2022
12 Nov 10, 2022
3 Mar 06, 2022