lfreleng-actions/🐍 Python Dependency Audit

Check Python dependencies for known security vulnerabilities

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jul 8, 2026
License
None

Pinned Snippet

workflow.ymlSHA-pinned
uses: lfreleng-actions/python-audit-action@fcb1b2e0cdbe19edf11057e598138f3d57f2b249 # v0.3.1

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
python_versionPython version used to perform audityes
artefact_nameArtefact name to download (defaults to project name)no
permit_failContinue/pass even when the audit failsnofalse
artefact_pathPath/location to build artefactsnodist
summaryWhether to generate summary outputnotrue
path_prefixDirectory location containing project codeno""
ignore_vulnsVulnerability IDs to ignore (whitespace separated). These IDs are merged with any IDs sourced from the allow-list file (see the allow_list_* inputs); duplicates are de-duplicated. noGHSA-4xh5-x5gv-qwph
allow_list_pathLocal filesystem path to a vulnerability allow-list file. When set, takes precedence over allow_list_url and allow_list_org. The path string itself must not contain newline characters; the file it points to may be multi-line. File format: whitespace-separated vulnerability IDs (CVE-, GHSA-, PYSEC-, OSV-, PVE-); '#' introduces a comment (full-line or trailing). no""
allow_list_urlRemote HTTPS URL to download the allow-list from. Ignored when allow_list_path is set. When both allow_list_path and allow_list_url are empty the action constructs a default URL from allow_list_org (see below). The URL string itself must not contain newline characters. no""
allow_list_orgGitHub organisation/owner used to construct the default allow-list URL when neither allow_list_path nor allow_list_url is supplied. Defaults at runtime to github.repository_owner. Default URL pattern: https://raw.githubusercontent.com/<org>/.github/HEAD/.github/python-audit/<org>/allow_list.txt no""
allow_list_disableWhen 'true', skip allow-list loading entirely and use only the 'ignore_vulns' input. nofalse
configGitHub-Actions uses-style coordinate identifying a remote allow-list file, fetched with a shallow, ref-pinned git fetch (supports branch, tag or commit SHA). Mutually exclusive with the allow_list_path, allow_list_url, allow_list_org and allow_list_disable inputs; supplying any of them together with 'config' is an error (allow_list_summary is still honoured). See the README for the full grammar. no""
tokenToken used to authenticate the git fetch when 'config' targets a private host repository. Leave empty for public repositories. GITHUB_TOKEN only grants access to the current repository; reading a private config repo in another org needs a PAT or GitHub App token with contents:read on that repo. no""
allow_list_summaryWhether to write the allow-list/config block to the job step summary. Set to 'false' to suppress it. Useful for matrix jobs, where the same block would otherwise repeat once per leg; emit it on a single matrix leg only (see the README for the strategy.job-index pattern). notrue
namedescription
resolved_host_orgHost org the config file was fetched from
resolved_repoRepository the config file was fetched from
resolved_refGit ref requested for the config fetch
resolved_shaExact commit SHA the config ref resolved to
resolved_pathIn-repo path of the matched config file
matched_candidateSearch candidate that matched