search

nikitasavinov / checkstyle-action

Run Java checkstyle with reviewdog in github actions
MIT License
59 stars 36 forks source link

Correction in readme #34

Open james-s-w-clark opened 2 years ago

james-s-w-clark commented 2 years ago

https://github.com/nikitasavinov/checkstyle-action#checkstyle_config

checkstyle_config
Required......

It's not in the example usage - so either the example usage is broken, or it's not a required field. I'm not sure what the preference is, so I'm raising an issue rather than a PR :)

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'
harikesh409 commented 1 year ago

The checkstyle_config is a required field only but as it got a default value so even if it's not mentioned while calling the action it's not a problem