Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
code

GitHub Action

Run java checkstyle

0.5.0

Run java checkstyle

code

Run java checkstyle

Run java checkstyle with reviewdog

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Run java checkstyle

uses: nikitasavinov/checkstyle-action@0.5.0

Learn more about this action in nikitasavinov/checkstyle-action

Choose a version

Checkstyle GitHub Action

Runs checkstyle with reviewdog on pull requests.

Example:

github-pr-check sample

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.

Important: this feature only works when level is set to error.

tool_name

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

workdir

Optional. Working directory relative to the root directory.

checkstyle_version

Optional. Checkstyle version to use. Default is 8.40

properties_file

Optional. Properties file 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'