scanoss/SCANOSS Code Scan Action

Scan your code from GH Workflow and take action based on detected components

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
halt_on_errorStop the pipeline if an error is encountered as opposed to a policy failurenotrue
policiesList of policies separated by comma (e.g., copyleft, undeclared, dt)no
policies.halt_on_failureHalt if a check failsnotrue
api.keySCANOSS API Key token (optional - not required for default OSSKB URL)no
api.urlSCANOSS API URL (optional - default: https://api.osskb.org/scan/direct)no
dependencies.enabledScan dependencies (optional - default false)nofalse
dependencies.scopeGets development or production dependencies (scopes - prod|dev)no""
dependencies.scope.includeCustom list of dependency scopes to be included. Provide scopes as a comma-separated list.no""
dependencies.scope.excludeCustom list of dependency scopes to be excluded. Provide scopes as a comma-separated list.no""
output.filepathScanner results filepathnoscanoss-raw.json
github.tokenYour GitHub tokenno${{ github.token }}
licenses.copyleft.includeList of Copyleft licenses to append to the default list. Provide licenses as a comma-separated list.no
licenses.copyleft.excludeList of Copyleft licenses to remove from default list. Provide licenses as a comma-separated list.no
licenses.copyleft.explicitExplicit list of Copyleft licenses to consider. Provide licenses as a comma-separated list.no
runtimeContainerSpecify runtime container to perform the scan.noghcr.io/scanoss/scanoss-py:v1.52.1
skipSnippetsSkip the generation of snippets.nofalse
scanFilesEnable or disable file and snippet scanning.notrue
scanossSettingsSettings file to use for scanning.notrue
settingsFilepathSCANOSS settings file path.noscanoss.json
scanModeDelta (diff) or full scannofull
scanPathRelative path within the repository to scan (e.g., "src" or "packages/api"). Must be relative, no parent directory references (..) allowed.no.
debugEnable debugging on scanoss.pynofalse
deptrack.uploadEnable Dependency Track uploadnofalse
deptrack.urlDependency Track base URLno
deptrack.apikeyDependency Track API keyno
deptrack.projectidDependency Track project UUIDno
deptrack.projectnameDependency Track project nameno
deptrack.projectversionDependency Track project versionno
matchAnnotationsEnable or disable match annotationsnotrue
namedescription
result-filepathScanner results filepath
stdout-scan-commandScanner command output