Skip to content

Document the secret_scan package metadata field #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericmj merged 1 commit into from
Aug 11, 2026
Merged

Document the secret_scan package metadata field #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions package_metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,17 @@ All keys are strings.

Extra information about the package

+ `secret_scan (kvlist(...)) (optional)`

Configuration for the repository's secret scanning of the package.

+ `ignore (list(string)) (optional)`

File path globs whose findings are suppressed. `*` matches within a
path segment, `**` spans separators, `?` matches one non-separator
character. Intended for paths a package deliberately ships secret-like
values in, such as test fixtures.

### Optional dependencies

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).
Expand Down