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 }}
0 Dec 26, 2021
10 Sep 26, 2022
2 May 10, 2022
1 Nov 19, 2022
16 Nov 06, 2022
129 Sep 20, 2022
3 Aug 26, 2022
0 Sep 13, 2022
1 Oct 23, 2021
0 Jan 03, 2022
2 Dec 20, 2021
85 Jan 03, 2023
269 Dec 23, 2022
226 Jan 02, 2023
6 Mar 31, 2022
1 Dec 12, 2021
70 Jan 02, 2023
1 Nov 16, 2021
4.5k Dec 30, 2022
24 Nov 11, 2022