Compare commits

..

1 Commits

Author SHA1 Message Date
Simarpreet Singh
040f2f6248 docs: Fix docs and add improved example repo
Signed-off-by: Simarpreet Singh <simar@linux.com>
2020-07-30 14:30:42 -07:00
3 changed files with 22 additions and 67 deletions
+17 -14
View File
@@ -1,6 +1,6 @@
# Trivy Action
> [GitHub Action](https://github.com/features/actions) for [Trivy](https://github.com/aquasecurity/trivy)
> [GitHub Action](https://github.com/features/actions) for Trivy
[![GitHub Release][release-img]][release]
[![GitHub Marketplace][marketplace-img]][marketplace]
@@ -31,21 +31,22 @@ jobs:
name: Build
runs-on: ubuntu-18.04
steps:
- name: Setup Go
uses: actions/setup-go@v1
with:
go-version: 1.14
- name: Checkout code
uses: actions/checkout@v2
- name: Build an image from Dockerfile
run: |
docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
- name: Run Trivy vulnerability scanner
uses: aquasecurity/trivy-action@master
- name: Run vulnerability scanner
uses: aquasecurity/trivy-action@0.0.7
with:
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
format: 'table'
exit-code: '1'
ignore-unfixed: true
vuln-type: 'os,library'
severity: 'CRITICAL,HIGH'
```
@@ -63,28 +64,31 @@ jobs:
name: Build
runs-on: ubuntu-18.04
steps:
- name: Setup Go
uses: actions/setup-go@v1
with:
go-version: 1.14
- name: Checkout code
uses: actions/checkout@v2
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
- name: Build an image from Dockerfile
run: |
docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
- name: Run Trivy vulnerability scanner
- name: Run vulnerability scanner
uses: aquasecurity/trivy-action@master
with:
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
format: 'template'
template: '@/contrib/sarif.tpl'
output: 'trivy-results.sarif'
- name: Upload Trivy scan results to GitHub Security tab
- name: Upload Trivy scan results to Security tab
uses: github/codeql-action/upload-sarif@v1
with:
sarif_file: 'trivy-results.sarif'
```
You can find a more in-depth example here: https://github.com/aquasecurity/trivy-sarif-demo/blob/master/.github/workflows/scan.yml
You can find a more in-depth example here: https://github.com/aquasecurity/trivy-sarif-demo
## Customizing
@@ -100,12 +104,11 @@ Following inputs can be used as `step.with` keys:
| `output` | String | | Save results to a file |
| `exit-code` | String | `0` | Exit code when vulnerabilities were found |
| `ignore-unfixed` | Boolean | false | Ignore unpatched/unfixed vulnerabilities |
| `vuln-type` | String | `os,library` | Vulnerability types (os,library) |
| `severity` | String | `UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL` | Severities of vulnerabilities to be displayed |
[release]: https://github.com/aquasecurity/trivy-action/releases/latest
[release-img]: https://img.shields.io/github/release/aquasecurity/trivy-action.svg?logo=github
[marketplace]: https://github.com/marketplace/actions/aqua-security-trivy
[marketplace]: https://github.com/marketplace/actions/trivy-vulnerability-scanner
[marketplace-img]: https://img.shields.io/badge/marketplace-trivy--action-blue?logo=github
[license]: https://github.com/aquasecurity/trivy-action/blob/master/LICENSE
[license-img]: https://img.shields.io/github/license/aquasecurity/trivy-action
+5 -19
View File
@@ -1,17 +1,10 @@
name: 'Aqua Security Trivy'
name: 'Trivy Vulnerability Scanner'
description: 'Scans container images for vulnerabilities with Trivy'
author: 'Aqua Security'
inputs:
image-ref:
description: 'image reference'
required: true
artifact-type:
description: 'artifact type (image or fs)'
required: true
default: "image"
aritfact-ref:
description: 'artifact reference (image reference or file path)'
required: true
exit-code:
description: 'exit code when vulnerabilities were found'
required: false
@@ -19,17 +12,13 @@ inputs:
ignore-unfixed:
description: 'ignore unfixed vulnerabilities'
required: false
default: "false"
vuln-type:
description: 'comma-separated list of vulnerability types (os,library)'
required: false
default: 'os,library'
default: false
severity:
description: 'severities of vulnerabilities to be displayed'
required: false
default: 'UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL'
format:
description: 'output format (table, json, template)'
description: 'output format (table, json)'
required: false
default: 'table'
template:
@@ -44,12 +33,9 @@ runs:
using: 'docker'
image: 'docker://docker.io/aquasec/trivy:latest'
args:
- '${{ inputs.artifact-type }}'
- 'image'
- '--format=${{ inputs.format }}'
- '--template=${{ inputs.template }}'
- '--exit-code=${{ inputs.exit-code }}'
- '--ignore-unfixed=${{ inputs.ignore-unfixed }}'
- '--vuln-type=${{ inputs.vuln-type }}'
- '--severity=${{ inputs.severity }}'
- '--output=${{ inputs.output }}'
- '${{ inputs.artifact-ref }}'
- '${{ inputs.image-ref }}'
-34
View File
@@ -1,34 +0,0 @@
name: build
on:
push:
branches:
- master
pull_request:
jobs:
build:
name: Build
runs-on: ubuntu-18.04
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Build an image from Dockerfile
run: |
docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
- name: Run Trivy vulnerability scanner
uses: aquasecurity/trivy-action@master
with:
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
exit-code: '1'
ignore-unfixed: true
vuln-type: 'os,library'
format: 'template'
template: '@/contrib/sarif.tpl'
output: 'trivy-results.sarif'
severity: 'CRITICAL,HIGH'
- name: Upload Trivy scan results to GitHub Security tab
uses: github/codeql-action/upload-sarif@v1
with:
sarif_file: 'trivy-results.sarif'