diff --git a/README.md b/README.md index f401205..8c05e30 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ If vulnerabilities are found by Trivy, it creates the following GitHub Issue. ![image](./assets/img/issue.png) +## Feature + +- Scan vulnerability used by Trivy +- Create or Update GitHub Issue if vulnerabilities found + - Customize Issue title, label and assignee + - Issue body is generated by template parameter + ## Inputs |Parameter|Required|Default Value|Description| @@ -21,7 +28,7 @@ If vulnerabilities are found by Trivy, it creates the following GitHub Issue. |severity|False|HIGH,CRITICAL|Severities of vulnerabilities (separated by commma)| |vuln_type|False|os,library|Scan target are os and / or library (separated by commma)| |ignore_unfixed|False|false|Ignore unfixed vulnerabilities
Please specify `true` or `false`| -|template|False|N/A|Trivy --template option
By default, it uses src/default.tpl which is based on [contrib/html.tpl](https://github.com/aquasecurity/trivy/blob/main/contrib/html.tpl)
reference: [Report Formats - Trivy](https://aquasecurity.github.io/trivy/v0.18.3/examples/report/#template)| +|template|False|N/A|Path to template file
This parameter equals trivy --template option
By default, it uses src/default.tpl which is based on [contrib/html.tpl](https://github.com/aquasecurity/trivy/blob/main/contrib/html.tpl)
reference: [Report Formats - Trivy](https://aquasecurity.github.io/trivy/v0.18.3/examples/report/#template)| |issue_title|False|Security Alert|Issue title| |issue_label|False|trivy,vulnerability|Issue label (separated by commma)| |issue_assignee|False|N/A|Issue assignee (separated by commma)| diff --git a/assets/img/issue.png b/assets/img/issue.png index 12b6438..2b8cd6f 100644 Binary files a/assets/img/issue.png and b/assets/img/issue.png differ