Awesome
reviewdog-action-protolint
This GitHub Action runs protolint with reviewdog.
Usage
name: reviewdog
on: [pull_request]
jobs:
linter_name:
name: runner / protolint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: yoheimuta/action-protolint@v1
with:
github_token: ${{ secrets.github_token }}
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
reporter: github-pr-review
# Change reporter level if you need.
# GitHub Status Check won't become failure with warning.
level: warning
Input
inputs:
### Flags for reviewdog ###
level:
description: 'Report level for reviewdog [info,warning,error]'
default: 'error'
reporter:
description: 'Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].'
default: 'github-pr-check'
filter_mode:
description: |
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added.
default: 'added'
fail_on_error:
description: |
Exit code for reviewdog when errors are found [true,false]
Default is `false`.
default: 'false'
reviewdog_flags:
description: 'Additional reviewdog flags'
default: ''
### Flags for protolint ###
protolint_version:
description: 'Protolint version to be installed'
default: '0.46.3'
protolint_flags:
description: |
Flags and args to pass to protolint.
The path provided here is relative to the workdir path, provided in the workdir input.
Default is `.`, which makes protolint run on the path provided in the workdir input.
default: '.'
Example repository
https://github.com/yoheimuta/reviewdog-protolint-example/blob/main/.github/workflows/reviewdog.yml