This is a GitHub action to run Checkstyle check on your Java code and report status via reviewdog on pull request.
Checkstyle configuration specifies which ruleset to apply during the scan.
There are two built-in configurations in checkstyle: [google_checks.xml, sun_checks.xml].
google_checks.xmlconfigures Checkstyle for the Google coding conventionssun_checks.xmlconfigures Checkstyle 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
Working directory relative to the root directory.
Default: .
Report level for reviewdog.
Values: [info, warning, error]
Default: info
Reporter of reviewdog command.
Values: [github-pr-check, github-check, github-pr-review]
Default: github-pr-check
Filtering mode for the reviewdog command.
Values: [added, diff_context, file, nofilter]
Default: added
Exit code for reviewdog when errors are found.
Values: [true, false]
Default: false
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/[email protected]
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 [info,warning,error].
# GitHub Status Check won't become failure with a warning.
level: warning