Skip to content

Allow a secret_scan package metadata key - #1221

Draft
ericmj wants to merge 1 commit into
mainfrom
secret-scan-ignore-metadata
Draft

Allow a secret_scan package metadata key#1221
ericmj wants to merge 1 commit into
mainfrom
secret-scan-ignore-metadata

Conversation

@ericmj

@ericmj ericmj commented Aug 5, 2026

Copy link
Copy Markdown
Member

Adds :secret_scan to the package metadata carried into the tarball, so hexpm's credential scanner can read a per-package ignore list:

package: [
  secret_scan: [ignore: ["test/fixtures/**", "priv/certs/*.pem"]]
]

Documented in Hex.Package.configuration_doc/0. Companion to the hexpm scanner and the field definition in the specifications repo.

Companion PRs: hexpm/hexpm#1806, hexpm/specifications#77

The repository scans published tarballs for leaked credentials. A package
suppresses paths it deliberately ships secret-like values in, such as test
fixtures, with:

    package: [secret_scan: [ignore: ["test/fixtures/**"]]]

The key was dropped by the metadata whitelist; add it so the client writes it
into hex_metadata.config for the repository to read.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant