manfred-kaiser/requirements-check

Check a requirements.txt (or CycloneDX SBOM) for outdated dependencies and known vulnerabilities.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
filePath to the requirements.txt (or CycloneDX SBOM) to check.norequirements.txt
formatOutput format: table, json, sbom, html, or sarif.nosarif
outputPath to write the report to.norequirements-check-report
fail-on-vulnerabilityFail the step if any known vulnerability is found (checked after the SARIF upload, so findings still show up in the Security tab even when this fails the job).nofalse
no-securitySkip the OSV.dev vulnerability check.nofalse
no-transitive-checkSkip the transitive-dependency coverage warning.nofalse
constraintsPath to a loose, unresolved requirements file (e.g. a pip-compile .in source) to cross-check suggestions against.no""
target-python-versionTarget Python version (e.g. 3.11) for requires-python compatibility filtering. Defaults to setup-python-version.no""
proxyHTTP(S) proxy URL for PyPI/OSV requests.no""
ca-bundlePath to a custom CA bundle file for TLS verification.no""
requirements-check-versionVersion of the requirements-check PyPI package to install. Defaults to the latest release.no""
setup-python-versionPython version used to run requirements-check itself.no3.13
upload-sarifAutomatically upload the report to GitHub code scanning. Only applies when format is sarif.notrue
namedescription
report-pathPath to the generated report file.
exit-coderequirements-check's own exit code (0 success, 1 vulnerabilities found, 2 usage error).