actions-marketplace-validations/Run shellcheck with reviewdog
🐶 Run shellcheck with reviewdog on pull requests to improve code review experience.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | GITHUB_TOKEN. | no | ${{ github.token }} |
| level | Report level for reviewdog [info,warning,error] | no | error |
| reporter | Reporter of reviewdog command [github-pr-check,github-pr-review,github-check]. Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports. | no | github-pr-check |
| filter_mode | Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is `file`. | no | file |
| fail_level | If set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none,any,info,warning,error] Default is `none`. | — | none |
| fail_on_error | Deprecated, use `fail_level` instead. Exit code for reviewdog when errors are found [true,false] Default is `false`. | no | false |
| reviewdog_flags | Additional reviewdog flags | no | "" |
| path | Base directory to run shellcheck. Same as `[path]` of `find` command. | no | . |
| pattern | File patterns of target files. Same as `-name [pattern]` of `find` command. | no | *.sh |
| check_all_files_with_shebangs | Checks all files with shebangs in the repository even if they do not match the pattern. Default is `false`. | no | false |
| exclude | Exclude patterns of target files. Same as `-not -path [exclude]` of `find` command. | no | */.git/* |
| shellcheck_flags | Flags of shellcheck command. | no | --external-sources |
Outputs
no outputs