This is a GitHub action to run Checkstyle check on your Java code and report status via reviewdog on pull request.

• checkstyle_config

  Checkstyle configuration specifies which ruleset to apply during the scan.
  There are two built-in configurations:

  • google_checks.xml config for the Google coding conventions
  • sun_checks.xml config for the Sun coding conventions

  It is also possible to supply your custom Checkstyle configuration file located in the same directory.

  Default: google_checks.xml

• checkstyle_version

  Checkstyle version to be used during analysis.
  For a list of available version numbers go to Checkstyle release page.

  Default: 8.41

• workdir

  Working directory relative to the root directory.

  Default: .

• level

  Report level for reviewdog.

  Values: [info, warning, error]

  You can control GitHub status check result with this feature.

  Level	GitHub Status
  info	neutral
  warning	neutral
  error	failure

  Default: info

• reporter

  Reporter of reviewdog command.
  See more in reviewdog documentation: https://github.com/reviewdog/reviewdog#reporters

  Values: [github-pr-check, github-check, github-pr-review]

  Default: github-pr-check

• filter_mode

  Filtering mode for the reviewdog command.
  See more in reviewdog documentation: https://github.com/reviewdog/reviewdog#filter-mode

  Values: [added, diff_context, file, nofilter]

  Default: added

• fail_on_error

  Exit code for reviewdog when errors are found.

  Values: [true, false]

  Default: false

• reviewdog_flags

  Additional reviewdog flags.

  Default: ``

name: reviewdog
on: [pull_request]
jobs:
  checkstyle:
    name: runner / checkstyle
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: dbelyaev/action-checkstyle@master
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review
          level: warning