Skip to content

Commit f901468

Browse files
authored
Merge pull request #68 from reviewdog/add_fail_level
Add fail_level and deduplicate fail_on_error
2 parents 28fb422 + adf21b3 commit f901468

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ code review experience.
1111

1212
## Inputs
1313

14+
<!-- markdownlint-disable MD013 -->
1415
```yml
1516
inputs:
1617
github_token:
@@ -28,10 +29,19 @@ inputs:
2829
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
2930
Default is added.
3031
default: 'added'
32+
fail_level:
33+
description: |
34+
If set to `none`, always use exit code 0 for reviewdog.
35+
Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level.
36+
Possible values: [none,any,info,warning,error]
37+
Default is `none`.
38+
default: 'none'
3139
fail_on_error:
3240
description: |
41+
Deprecated, use `fail_level` instead.
3342
Exit code for reviewdog when errors are found [true,false]
3443
Default is `false`.
44+
deprecationMessage: Deprecated, use `fail_level` instead.
3545
default: 'false'
3646
reviewdog_flags:
3747
description: 'Additional reviewdog flags'
@@ -41,6 +51,7 @@ inputs:
4151
description: "Options of markdownlint-cli command. Default: '.'"
4252
default: '.'
4353
```
54+
<!-- markdownlint-enable MD013 -->
4455
4556
## Example usage
4657

action.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,19 @@ inputs:
1717
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
1818
Default is added.
1919
default: 'added'
20+
fail_level:
21+
description: |
22+
If set to `none`, always use exit code 0 for reviewdog.
23+
Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level.
24+
Possible values: [none,any,info,warning,error]
25+
Default is `none`.
26+
default: 'none'
2027
fail_on_error:
2128
description: |
29+
Deprecated, use `fail_level` instead.
2230
Exit code for reviewdog when errors are found [true,false]
2331
Default is `false`.
32+
deprecationMessage: Deprecated, use `fail_level` instead.
2433
default: 'false'
2534
reviewdog_flags:
2635
description: 'Additional reviewdog flags'

entrypoint.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ markdownlint ${INPUT_MARKDOWNLINT_FLAGS:-.} 2>&1 \
1313
-name="markdownlint" \
1414
-reporter="${INPUT_REPORTER:-github-pr-check}" \
1515
-filter-mode="${INPUT_FILTER_MODE}" \
16+
-fail-level="${INPUT_FAIL_LEVEL}" \
1617
-fail-on-error="${INPUT_FAIL_ON_ERROR}" \
1718
-level="${INPUT_LEVEL}" \
1819
${INPUT_REVIEWDOG_FLAGS} || EXIT_CODE=$?

0 commit comments

Comments
 (0)