andersonshatch/Contrast Security Combined Scan

Composite action that runs both Contrast SCA and Local Scan actions

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Dec 9, 2025
License
None

Pinned Snippet

workflow.ymlSHA-pinned
uses: andersonshatch/scan-and-sca@0111d9d4fdc115d15252e04843baed15b56dc3cb # no releases — HEAD as of 2026-07-13

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

namedescriptionrequireddefault
apiUrlURL of your Contrast instanceyeshttps://app.contrastsecurity.com
apiKeyAPI Key from user settings (required for both actions)yes
apiUserNameUser name for authentication (required for both actions)yes
apiServiceKeyService Key from user settings (required for both actions)yes
orgIdOrganization ID from user settings (required for both actions)yes
filePathSpecify the directory in which to search for project configuration files (required for SCA)no
repositoryIdThe ID of your repo (SCA)no
projectGroupIdThe ID of your project Groups (SCA)no
applicationIdThe ID of your application (SCA)no
ignoreDevWhen set to true, excludes developer dependencies from the results (SCA)no
outputSummaryDefaults to true. When set to true, writes the output of the audit to the GitHub Actions Summary (SCA)notrue
proxyWhen set will pass the proxy url to the contrast cli (SCA)no
repoUrlWhen set, will pass the optional repo url parameter to the contrast cli (SCA)no
repoNameWhen set, will pass the optional repo name parameter to the contrast cli (SCA)no
externalIdWhen set, will pass the optional external id parameter to the contrast cli (SCA)no
auditTimeoutSets the timeout for an audit in seconds, Default: 600 (10 minutes) (SCA)no600
metadataMetadata filter to be passed to the Contrast CLI when running sarif command (SCA)no
ghasEnabledWhen set to true, will upload sarif to the GHAS integration (SCA)notrue
legacyWhen set to true, uses the legacy audit command (SCA)no
modifierWhen set this will be added as a suffix to the output file name (SCA)no
nameContrast project name. If not specified, Contrast uses the file folder name to identify the project or creates a new project (SCA)no
commandCommand to run cli with audit/fingerprint/sarif (SCA)noaudit
checksIf set, checks will be added to the current commit based on any vulnerabilities found. Requires the "checks: write" permission (Local Scan)nofalse
codeQualitySet this to true to include code quality rules when executing source code scanner (Local Scan)nofalse
defaultBranchSet this to true or false explicitly override the default branching behaviour in scan (Local Scan)no
labelLabel to associate with the current scan. Defaults to the current ref e.g. refs/heads/main (Local Scan)no
memoryMemory setting passed to the underlying scan engine. Defaulted to 8g (Local Scan)no
newSet this to true or false to only fail the action on new vulnerabilities (Local Scan)no
pathPath to scan with local scanner. Defaults to the current repository path (Local Scan)no
projectNameProject to associate scan with. Defaults to current github repository name (Local Scan)no
strategyUsed in conjunction with severity or checks, set this value to fail the build based on aggregated project vulnerabilities or scan level. Valid values are "project" or "scan". Defaults to "project" (Local Scan)noproject
timeoutExecution timeout (in seconds) setting passed to the underlying scan engine. Defaulted to 60 minutes (Local Scan)no
tokenGitHub token for GitHub API requests. Defaults to GITHUB_TOKEN (Local Scan)no${{ github.token }}
severitySet this to cause the build to fail if vulnerabilities are found exceeding this severity or higher. Valid values are CRITICAL, HIGH, MEDIUM, LOW, NOTEnoCRITICAL
failWhen set to true, fails the action if CVEs have been detected that match at least the severity option specifiedno
resourceGroupResource group to assign newly created projects tono
runScaSet to true to run the SCA actionnotrue
runLocalScanSet to true to run the Local Scan actionnotrue
namedescription
fingerprintOutput from the SCA fingerprint command