GitHub Action: Run eslint with reviewdog
This action runs eslint with reviewdog on pull requests to improve code review experience.
Inputs
github_token
Required. Must be in form of github_token: ${{ secrets.github_token }}
'.
level
Optional. Report level for reviewdog [info,warning,error].
It's same as -level
flag of reviewdog.
reporter
Reporter of reviewdog command [github-pr-check,github-pr-review]. Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
eslint_flags
Optional. Flags and args of eslint command. Default: '.'
Example usage
You also need to install eslint.
# Example
$ npm install eslint -D
You can create eslint config and this action uses that config too.
.github/workflows/reviewdog.yml
name: reviewdog
on: [pull_request]
jobs:
eslint:
name: runner / eslint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: eslint
uses: reviewdog/action-eslint@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Change reporter.
eslint_flags: 'src/'