Skip to content

Run checkstyle (Code Standard) with reviewdog

Actions
🐶 Run checkstyle with reviewdog on pull requests to improve code review experience
v1.1.0
Latest
Star (1)

action-template

Test reviewdog depup release GitHub release (latest SemVer) action-bumpr supported

Input

inputs:
  github_token:
    description: 'GITHUB_TOKEN'
    default: '${{ github.token }}'
  workdir:
    description: 'Working directory relative to the root directory.'
    default: '.'
  ### Flags for reviewdog ###
  level:
    description: 'Report level for reviewdog [info,warning,error]'
    default: 'error'
  reporter:
    description: 'Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].'
    default: 'github-pr-check'
  filter_mode:
    description: |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default: 'added'
  fail_on_error:
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default: 'false'
  reviewdog_flags:
    description: 'Additional reviewdog flags'
    default: ''
  ### Parameters for checkstyle ###
  configuration_file:
    description: '-c parameter. Specifies the location of the file that defines the configuration modules.'
    default: 'google_checks.xml'

Usage

name: checkstyle
on: [pull_request]
jobs:
  linter_name:
    name: runner / checkstyle
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: asaasdev/checkstyle-action@v1
        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.
          # GitHub Status Check won't become failure with warning.
          level: warning

Run checkstyle (Code Standard) with reviewdog is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

🐶 Run checkstyle with reviewdog on pull requests to improve code review experience
v1.1.0
Latest

Run checkstyle (Code Standard) with reviewdog is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.