Skip to content

Commit

Permalink
rule: Update trivy guidance
Browse files Browse the repository at this point in the history
This renders better in our CLI and gives an example.
  • Loading branch information
JAORMX committed Sep 26, 2023
1 parent c67f5c5 commit 13f4a4b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions examples/github/rule-types/trivy_action_enabled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,25 @@ context:
group: Root Group
description: Verifies that the Trivy action is enabled for the repository and scanning
guidance: |
## Please set up trivy!
Trivy is an open source vulnerability scanner for repositories, containers and other
artifacts provided by Aqua Security. It is used to scan for vulnerabilities in the
codebase and dependencies. This rule ensures that the Trivy action is enabled for
the repository and scanning is performed.
For more information on the Trivy action, see https://github.com/marketplace/actions/aqua-security-trivy
Set it up by adding the following to your workflow:
```yaml
- name: Trivy Scan
uses: aquasecurity/trivy-action@fbd16365eb88e12433951383f5e99bd901fc618f # v0.12.0
with:
image-ref: ${{ github.repository }}
format: json
exit-code: 1
```
def:
# Defines the section of the pipeline the rule will appear in.
# This will affect the template that is used to render multiple parts
Expand Down

0 comments on commit 13f4a4b

Please sign in to comment.