Skip to content

Commit 709cc94

Browse files
committed
Slightly re-word descriptions of a few params
Consolidate 'findings', 'issues', 'violations' -> 'violations' Signed-off-by: Adam Cmiel <acmiel@redhat.com>
1 parent 720846c commit 709cc94

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ jobs:
5353
5454
### `differential`
5555

56-
Report new issues introduced in a Pull Request, ignore existing issues. Set to
57-
false to report all issues in all files.
56+
Report new violations introduced in a Pull Request, ignore existing violations.
57+
Set to false to report all violations in all files.
5858

5959
* default: `true`
6060

@@ -84,7 +84,7 @@ Hash of the latest commit in the Pull Request.
8484

8585
### `fail-on-findings`
8686

87-
Fail when ShellCheck reports some findings? (May wish to set this to false if
87+
Fail when ShellCheck reports some violations? (May wish to set this to false if
8888
you're going to upload the SARIF report anyway. GitHub takes care of the
8989
reporting.)
9090

@@ -114,7 +114,7 @@ git-diff manpage).
114114

115115
### `display-style`
116116

117-
Display the findings in the specified style. Valid values: csgrep, sarif-fmt
117+
Display violations in the specified style. Valid values: csgrep, sarif-fmt
118118

119119
* default: `sarif-fmt`
120120

action.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ inputs:
1111
# inspired by https://github.com/redhat-plumbers-in-action/differential-shellcheck/blob/main/action.yml
1212
differential:
1313
description: >-
14-
Report new issues introduced in a Pull Request, ignore existing issues.
15-
Set to false to report all issues in all files.
14+
Report new violations introduced in a Pull Request, ignore existing violations.
15+
Set to false to report all violations in all files.
1616
required: false
1717
default: true
1818
include-regex:
@@ -33,7 +33,7 @@ inputs:
3333
default: ${{ github.event.pull_request.head.sha }}
3434
fail-on-findings:
3535
description: >-
36-
Fail when ShellCheck reports some findings? (May wish to set this to false if you're
36+
Fail when ShellCheck reports some violations? (May wish to set this to false if you're
3737
going to upload the SARIF report anyway. GitHub takes care of the reporting.)
3838
required: false
3939
default: true
@@ -58,7 +58,7 @@ inputs:
5858
default: false
5959
display-style:
6060
description: >-
61-
Display the findings in the specified style. Valid values: csgrep, sarif-fmt
61+
Display violations in the specified style. Valid values: csgrep, sarif-fmt
6262
default: sarif-fmt
6363
required: false
6464

0 commit comments

Comments
 (0)