feat(code-scanning): Update Trivy starter workflows#2872
feat(code-scanning): Update Trivy starter workflows#2872simar7 wants to merge 1 commit intoactions:mainfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Trivy starter workflows for Code Scanning by introducing a new repository vulnerability scan workflow, updating the IaC scan workflow to the latest recommended examples, and deprecating the tfsec workflow.
- Adds code-scanning/trivy-vulnerability-scan.yml for repo vulnerability scanning.
- Updates code-scanning/trivy-iac-scan.yml with a more descriptive name, explicit OS version, and revised Trivy action version.
- Removes the deprecated tfsec.yml workflow.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| code-scanning/trivy-vulnerability-scan.yml | New workflow for running Trivy vulnerability scans in repository (fs) mode. |
| code-scanning/trivy-iac-scan.yml | Updated workflow for running Trivy IaC scans with revised parameters and OS version. |
| code-scanning/tfsec.yml | Deprecated tfsec workflow has been removed. |
Comments suppressed due to low confidence (2)
code-scanning/trivy-iac-scan.yml:6
- [nitpick] Consider verifying that including 'IaC' in the workflow name aligns with our naming convention, which generally uses only the language or platform name.
name: Trivy IaC Scan
code-scanning/trivy-iac-scan.yml:33
- Ensure that version 0.30.0 of the Trivy action has been fully verified with these workflow settings, as the action behavior and supported flags may have changed from previous versions.
uses: aquasecurity/trivy-action@0.30.0
Signed-off-by: simar <simar@linux.com>
|
@DanRigby I'm not sure whose the right person to ask but is it possible if we could approve and merge this if it looks good to the team? |
| exit-code: '1' | ||
| severity: 'CRITICAL,HIGH' | ||
|
|
||
| - name: Upload Trivy scan results to GitHub Security tab | ||
| uses: github/codeql-action/upload-sarif@v3 | ||
| if: always() |
There was a problem hiding this comment.
If you use github/codeql-action/upload-sarif (which this workflow does) and your workflow yields a failure (which the exit-code: 1 would if I'm reading the docs correctly), then github's sarif stuff will say your workflow is broken, so you don't want to report an error via the workflow, instead you want to report things via upload-sarif and tell people to use a ruleset.
I describe this in my (check-spelling v0.0.25 release notes](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.25): Code Scanning action requires a Code Scanning Ruleset
I think this is correct:
| exit-code: '1' | |
| severity: 'CRITICAL,HIGH' | |
| - name: Upload Trivy scan results to GitHub Security tab | |
| uses: github/codeql-action/upload-sarif@v3 | |
| if: always() | |
| exit-code: '0' | |
| severity: 'CRITICAL,HIGH' | |
| - name: Upload Trivy scan results to GitHub Security tab | |
| uses: github/codeql-action/upload-sarif@v3 |
Description
This PR updates the Trivy workflows to the latest recommended workflow examples. Also deprecates the
tfsecworkflow as we've integrated its functionality into Trivy.Signed-off-by: Simar simar@linux.com
Pre-requisites
Please note that at this time we are only accepting new starter workflows for Code Scanning. Updates to existing starter workflows are fine.
Tasks
For all workflows, the workflow:
.ymlfile with the language or platform as its filename, in lower, kebab-cased format (for example,docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").GITHUB_TOKENso that the workflow runs successfully.For CI workflows, the workflow:
cidirectory.ci/properties/*.properties.jsonfile (for example,ci/properties/docker-publish.properties.json).pushtobranches: [ $default-branch ]andpull_requesttobranches: [ $default-branch ].releasewithtypes: [ created ].docker-publish.yml).For Code Scanning workflows, the workflow:
code-scanningdirectory.code-scanning/properties/*.properties.jsonfile (for example,code-scanning/properties/codeql.properties.json), with properties set as follows:name: Name of the Code Scanning integration.creator: Name of the organization/user producing the Code Scanning integration.description: Short description of the Code Scanning integration.categories: Array of languages supported by the Code Scanning integration.iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in theiconsdirectory.pushtobranches: [ $default-branch, $protected-branches ]andpull_requesttobranches: [ $default-branch ]. We also recommend ascheduletrigger ofcron: $cron-weekly(for example,codeql.yml).Some general notes:
actionsorganization, or