checkstyle-action's Introduction

Checkstyle GitHub Action

Runs checkstyle with reviewdog on pull requests.

Example: https://github.com/nikitasavinov/checkstyle-action/pull/2/files

Input

`checkstyle_config`

Required. Checkstyle config Default is google_checks.xml (sun_checks.xml is also built in and available).

`level`

Optional. Report level for reviewdog [info,warning,error]. It's same as -level flag of reviewdog.

`reporter`

Optional. Reporter of reviewdog command [github-pr-check,github-pr-review]. It's same as -reporter flag of reviewdog.

`filter_mode`

Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added.

`fail_on_error`

Optional. Exit code for reviewdog when errors are found [true,false]. Default is false.

`tool_name`

Optional. Tool name to use for reviewdog reporter. Default is 'reviewdog'.

`workdir`

Optional. Working directory relative to the root directory.

Example usage

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'

Recommend Projects