Skip to content

Commit 9a8c4db

Browse files
committed
Add fail_level and deduplicate fail_on_error
1 parent ef8b22c commit 9a8c4db

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,15 @@ exclude: |
7474

7575
Optional. Filtering mode for the reviewdog command [`added`,`diff_context`,`file`,`nofilter`]. Default: `added`.
7676

77+
### `fail_level`
78+
79+
Optional. 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.
80+
Possible values: [`none`, `any`, `info`, `warning`, `error`]
81+
Default is `none`.
82+
7783
### `fail_on_error`
7884

85+
Deprecated, use `fail_level` instead.
7986
Optional. Exit code for reviewdog when errors are found [`true`,`false`]. Default: `false`.
8087

8188
## Example usage

action.yml

+8-1
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,15 @@ inputs:
2929
filter_mode:
3030
description: "Filtering mode for the reviewdog command [added,diff_context,file,nofilter]."
3131
default: 'added'
32+
fail_level:
33+
description: |
34+
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.
35+
Possible values: [none,any,info,warning,error]
36+
Default is `none`.
37+
default: 'none'
3238
fail_on_error:
33-
description: "Exit code for reviewdog when errors are found [true,false]."
39+
description: "Deprecated, use `fail_level` instead. Exit code for reviewdog when errors are found [true,false]."
40+
deprecationMessage: Deprecated, use `fail_level` instead.
3441
default: 'false'
3542
runs:
3643
using: 'docker'

entrypoint.sh

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ find "${paths[@]}" "${excludes[@]}" -type f "${names[@]}" -print0 \
3131
-name="misspell" \
3232
-reporter="${INPUT_REPORTER:-github-pr-check}" \
3333
-level="${INPUT_LEVEL}" \
34+
-fail-level="${INPUT_FAIL_LEVEL}" \
3435
-fail-on-error="${INPUT_FAIL_ON_ERROR}"
3536
exit_code=$?
3637

0 commit comments

Comments
 (0)