Skip to content

Commit 721b0a6

Browse files
authored
Merge pull request #3868 from mercedes-benz/feature-3867-improve-documentation-of-github-action
Improve documentation of GH action #3867
2 parents 5408835 + 1fdc80f commit 721b0a6

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

github-actions/scan/README.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,10 @@ To be able to use this action you need a SecHub project. Check the https://merce
8080
# DEFAULT: true
8181
fail-job-with-findings: true
8282
83-
# OPTIONAL: File that defines false positives. This step is executed before the scan. The SecHub cli defineFalsePositives overwrites the false positives on SecHub side with the ones defined in this file. Uses the SecHub cli getFalsePositives to get the current false positives and extend the returned false positive list.
83+
# OPTIONAL: The file that defines false positives.
84+
# This step is executed before the scan.
85+
# The action defineFalsePositives overwrites all previously marked false positives on SecHub side with the ones defined in this file.
86+
# You can use the SecHub client action getFalsePositives to get the current false positives and extend the returned false positive list.
8487
define-false-positives: 'sechub-false-positives.json'
8588
----
8689

github-actions/scan/action.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ inputs:
5858
required: false
5959
default: true
6060
define-false-positives:
61-
description: 'The file that defines false positives. This step is executed before the scan. The SecHub cli defineFalsePositives overwrites the false positives on SecHub side with the ones defined in this file. Uses the SecHub cli getFalsePositives to get the current false positives and extend the returned false positive list.'
61+
description: 'The file that defines false positives. This step is executed before the scan. The action defineFalsePositives overwrites all previously marked false positives on SecHub side with the ones defined in this file. You can use the SecHub client action getFalsePositives to get the current false positives and extend the returned false positive list.'
6262
required: false
6363

6464
outputs:

0 commit comments

Comments
 (0)