You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-12Lines changed: 7 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -162,36 +162,31 @@ security-detect-secrets
162
162
163
163
**Description:**
164
164
165
-
- This action is intended as a Continuous Integration secret scan in an already "clean" repository. The default commit scan depth is the last 50 commits and can be adjusted using Custom Arguments
165
+
- This action is intended as a Continuous Integration secret scan in an already "clean" repository.
166
166
167
-
- The stage checks for addition/deletion of any secret/sensitive data in last 50 commits of the repository.
167
+
- The stage checks for addition/deletion of any secret/sensitive data in referenced commits (commits pushed or commits within PR).
- The stage is likely to fail if there is some sensitive or secrets or confidential data had been removed or added in the last 50 commits.
173
+
- The stage is likely to fail if any sensitive secrets or confidential data were removed or added in the referenced commits.
174
174
175
175
**Troubleshooting steps for failures if any**
176
176
177
177
- User would need to update the commit history where the sensitive information is detected.
178
178
179
179
**Exception File**
180
180
181
-
- To ignore the file add the path of the file having the false positive in the `.github/workflows/exclude-patterns.txt`, ideally this should be avoided and only specific false positives should be added in exception files.
181
+
- To ignore the file add the path of the file having the false positive in the `.github/workflows/exclude-patterns.txt`, ideally this should be avoided and only specific false positives should be added in exception files. This is file with newline separated regexes for files to exclude in scan.
182
182
183
183
- False positives include: public keys, random / dummy session keys or tokens.
184
184
185
-
- We can use this file `.github/workflows/trufflehog-false-positive.json` from action version `>=v0.9l-beta` to add specific failures or regexes.
186
-
187
-
- ref for how to add regex to json file : https://github.com/edplato/trufflehog-actions-scan#usage
188
-
189
-
-**NOTE:** The usage of `.github/workflows/trufflehog-false-positive.json` is not rolled out yet, PR for feature support: https://github.com/splunk/addonfactory-workflow-addon-release/pull/32
190
-
185
+
- User can add a `trufflehog:ignore` comment on the line containing the secret to ignore that secrets.
191
186
192
187
**Artifacts:**
193
188
194
-
- No additional artifacts, the commit info is available in the logs.
189
+
- No additional artifacts, the commit info and secrets details are available in the logs.
0 commit comments