Skip to content
This repository was archived by the owner on Jun 29, 2021. It is now read-only.

Commit 2f7a2c2

Browse files
committed
Modify image parameter description for IMAGE_NAME env
1 parent eb5e6ca commit 2f7a2c2

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
![GitHub](https://img.shields.io/github/license/homoluctus/gitrivy?color=brightgreen)
55

66
This is a GitHub Actions to scan vulnerability using [Trivy](https://github.com/aquasecurity/trivy).<br>
7+
If vulnerabilities are found by Trivy, it creates the following GitHub Issue.
8+
9+
![image](https://github.com/homoluctus/gitrivy/issue.png)
710

811
## Usage
912

@@ -13,7 +16,7 @@ This is a GitHub Actions to scan vulnerability using [Trivy](https://github.com/
1316
|:--:|:--:|:--:|:--|
1417
|token|True|N/A|GitHub access token<br>${{ secrets.GITHUB_TOKEN }} is recommended|
1518
|trivy_version|False|latest|Trivy version|
16-
|image|True|N/A|The target image name to scan the vulnerability|
19+
|image|True|N/A|The target image name to scan the vulnerability<br>Specify this parameter or `IMAGE_NAME` environment variable|
1720
|severity|False|HIGH,CRITICAL|Sevirities of vulunerabilities (separeted by commma)|
1821
|vuln_type|False|os,library|Scan target are os and / or library (separeted by commma)|
1922
|ignore_unfixed|False|false|Ignore unfixed vulnerabilities<br>Specify true or false|

action.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ inputs:
1010
default: 'latest'
1111
required: false
1212
image:
13-
description: 'The target image name of vulnerability scan'
14-
required: true
13+
description: 'The target image name of vulnerability scan (specify this parameter or "IMAGE_NAME" environment variable'
14+
required: false
1515
severity:
1616
description: 'sevirities of vulunerabilities (separeted by commma)'
1717
default: 'HIGH,CRITICAL'

0 commit comments

Comments
 (0)