README.md

WARNING

reviewdog/action-eclint is no longer maintained. Please use another action. See #29

GitHub Action: Run eclint with reviewdog

This action runs eclint with reviewdog on pull requests to improve code review experience.

Inputs

github_token

Required. The default value is github_token: ${{ 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-check,github-pr-review]. Default is github-pr-check. It's same as -reporter flag of reviewdog.

github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

eclint_flags

Optional. Flags and args of eclint command. Default: '.'

Example usage

You can create eclint config and this action uses that config too.

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  eclint:
    name: runner / eclint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: eclint
        uses: reviewdog/action-eclint@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review # Change reporter.
          eclint_flags: 'src/'