Skip to content

Commit 7ecc6e2

Browse files
authored
Document the secret_scan package metadata field (#77)
The repository's secret scanning of published packages reads this to suppress findings in paths a package deliberately ships secret-like values in.
1 parent b172bf5 commit 7ecc6e2

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

package_metadata.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,17 @@ All keys are strings.
8383

8484
Extra information about the package
8585

86+
+ `secret_scan (kvlist(...)) (optional)`
87+
88+
Configuration for the repository's secret scanning of the package.
89+
90+
+ `ignore (list(string)) (optional)`
91+
92+
File path globs whose findings are suppressed. `*` matches within a
93+
path segment, `**` spans separators, `?` matches one non-separator
94+
character. Intended for paths a package deliberately ships secret-like
95+
values in, such as test fixtures.
96+
8697
### Optional dependencies
8798

8899
An optional dependency will only be used if a package higher up the dependency chain also depends on it (only if that the dependency is not defined as optional as well).

0 commit comments

Comments
 (0)