Skip to content

Commit 5a49d3f

Browse files
author
Cesar Rodriguez
committed
clarifies usage
1 parent bf7ae55 commit 5a49d3f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Terrascan GitHub Action
2-
This action runs Terrascan, a static code analyzer for infrastructure as code(IaC) security best practices. It supports displaying the results of the scan in the GitHub repository's Security tab under [code scanning alerts](https://docs.github.com/en/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning), when the `sarif_upload` input variable is set to true.
2+
This action runs Terrascan, a static code analyzer for infrastructure as code(IaC) security best practices. It supports displaying the results of the scan in the GitHub repository's Security tab under [code scanning alerts](https://docs.github.com/en/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning), when the `sarif_upload` input variable is included.
33

44
## Inputs
55
### `iac_type`
@@ -30,7 +30,7 @@ Config file path.
3030
The action will only warn and not error when violations are found.
3131

3232
### `sarif_upload`
33-
If true, a sarif file named terrascan.sarif will be generated with the results of the scan.
33+
If this variable is included, a sarif file named terrascan.sarif will be generated with the results of the scan.
3434

3535
## Example usage
3636

0 commit comments

Comments
 (0)