veraaccion10/Veracode Pipeline-Scan
Upload files to veracode and start a static pipeline-scan.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| vid | vid | yes | — |
| vkey | vkey | yes | — |
| file | Filename of the packaged application to upload and scan. | yes | — |
| token | GITHUB_TOKEN or a repo scoped PAT. | yes | ${{ github.token }} |
| veracode_policy_name | Name of the Veracode default policy or custom-built policy to apply to the scan results. | — | — |
| request_policy | DPERECATED, WILL BE REMOVED WITH NEXT VERSION - Name of the security policy to download as a file. Required only if you want to download the configuration for a custom policy defined by your organization. After downloading the policy, you can provide this file in a subsequent command using the policy_file parameter. | no | — |
| fail_on_severity | Fail the pipeline job if the scan finds flaws of the specified severities. Enter a comma-separated list of severities in quotation marks. | no | — |
| fail_on_cwe | Fail the pipeline job if the scan finds flaws of the specified CWEs. Enter a comma-separated list of CWE IDs. | no | — |
| baseline_file | Filter the flaws that exist in the specified baseline file and show only the additional flaws in the current scan. | no | — |
| policy_name | DPERECATED, WILL BE REMOVED WITH NEXT VERSION - Name of the Veracode default policy rule to apply to the scan results. You can only use this parameter with a Veracode default policy. | no | — |
| policy_file | Name of the local policy file you want to apply to the scan results. | no | — |
| timeout | Amount of time, in minutes, for the Pipeline Scan to wait before reporting an unsuccessful scan if the scan does not complete. Default is 60 minutes, which is also the maximum value. | no | — |
| issue_details | Enter true to show detailed messages for each issue in the results summary. | no | — |
| summary_display | Enter true to show a human-readable results summary on the console. Default is true. | no | — |
| json_display | Enter true to show the JSON containing the scan results on the console. Default is false. | no | — |
| verbose | Enter true to display detailed messages in the scan results. Default is false. | no | — |
| summary_output | Enter true to save the scan results as a human-readable file. Default is false. | no | — |
| summary_output_file | Enter the filename of the scan results summary file. The file is stored in the current directory. Default is results.txt. | no | — |
| json_output | Enter true to save the scan results in JSON format. Default is true. | no | — |
| json_output_file | Rename the JSON file that contains the scan results. The file is stored in the current directory. Default filename is results.json. | no | — |
| filtered_json_output_file | Enter the filename in the current directory to save results that violate pass-fail criteria. Default is filtered_results.json. | no | — |
| project_name | Enter the name of the CI/CD code repository that runs a Pipeline Scan. This parameter adds the repository name to the scan results, which can help you track scans across repositories. | no | — |
| project_url | Enter the source control URL for the CI/CD code repository that runs a Pipeline Scan. | no | — |
| project_ref | Enter the source control reference, revision, or branch for the CI/CD code repository that runs a Pipeline Scan. | no | — |
| app_id | Enter the [application profile](https://docs.veracode.com/r/request_profile) ID for the application you want to upload and scan. | no | — |
| development_stage | Enter one these values, which are case-sensitive, for the type of development stage: Development, Testing, Release. | no | — |
| debug | Enable debug mode. 1 for on | no | — |
| store_baseline_file | Enable the storage of a baseline file. Takes true or fales | no | — |
| store_baseline_file_branch | Enter the branch name where the baseline file should be stored | no | — |
| create_baseline_from | From which results should the baseline file be created. standard = full results || filtered = filtered results | no | — |
| fail_build | Fail the build upon findings. Takes true or false | no | — |
| include | Enter a case-sensitive, comma-separated list of name patterns that represent the names of the modules to scan as top-level modules. Veracode identifies these modules during prescan. The * wildcard matches zero or more characters. The ? wildcard matches exactly one character. For example, to include various module names that contain module: --include "module 1, module-*, module2.jar". The scan results show the names of the modules that Veracode identified and the modules included in the scan. This parameter does not pause, stop, or impact the performance of your pipeline. | no | — |
Outputs
no outputs