GitHub Action
Run java checkstyle
Runs checkstyle with reviewdog on pull requests.
Example:
Required. Checkstyle config
Default is google_checks.xml
(sun_checks.xml
is also built in and available).
Optional. Report level for reviewdog [info,warning,error].
It's same as -level
flag of reviewdog.
Optional. Reporter of reviewdog command [github-pr-check,github-pr-review].
It's same as -reporter
flag of reviewdog.
Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added
.
Optional. Exit code for reviewdog when errors are found [true,false].
Default is false
.
Important: this feature only works when level
is set to error
.
Optional. Tool name to use for reviewdog reporter. Default is 'reviewdog'.
Optional. Working directory relative to the root directory.
Optional. Checkstyle version to use.
Default is 8.40
Optional. Properties file relative to the root directory.
on: pull_request
jobs:
checkstyle_job:
runs-on: ubuntu-latest
name: Checkstyle job
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Run check style
uses: nikitasavinov/checkstyle-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: 'github-pr-check'
tool_name: 'testtool'