Skip to content

Commit e89e82e

Browse files
Release: v0.1.1 (#40)
## What's Changed * security: bump undici from 5.28.3 to 5.28.4 by @dependabot in #28 * Add note field in response of the IaC Validation API by @pankhurisaxena28 in #32 * Update SCAN_FILE_MAX_SIZE_BYTES to 2MB by @pankhurisaxena28 in #33 * Update deps and switch to actions-gen-readme for autodoc by @sethvargo in #34 * Added iac scan information uri by @sanyam803 in #36 * update default scan timeout to 3 minutes by @pankhurisaxena28 in #37 * Update README.md by @pankhurisaxena28 in #38 ## New Contributors * @pankhurisaxena28 made their first contribution in #32 **Full Changelog**: v0.1.0...1874879
1 parent 1874879 commit e89e82e

File tree

4 files changed

+25
-14
lines changed

4 files changed

+25
-14
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ jobs:
8686
<!-- BEGIN_AUTOGEN_INPUTS -->
8787
8888
- <a name="organization_id"></a><a href="#user-content-organization_id"><code>organization_id</code></a>: _(Required)_ Google Cloud organization ID for the organization which includes the
89-
resources that you want to modify.
89+
resources that you want to modify. For example, '1234'.
9090
9191
- <a name="scan_file_ref"></a><a href="#user-content-scan_file_ref"><code>scan_file_ref</code></a>: _(Required)_ Path to a file, relative to the local workspace, for the IaC file to scan.
9292
For example:
@@ -97,25 +97,31 @@ jobs:
9797
9898
./artifacts/tf_plan.json
9999
100-
- <a name="iac_type"></a><a href="#user-content-iac_type"><code>iac_type</code></a>: _(Required, default: `terraform`)_ IaC template type. Currently only `terraform` is supported.
100+
- <a name="iac_type"></a><a href="#user-content-iac_type"><code>iac_type</code></a>: _(Required, default: `terraform`)_ The IaC template type. Currently only Terraform is supported.
101101

102-
- <a name="scan_timeout"></a><a href="#user-content-scan_timeout"><code>scan_timeout</code></a>: _(Optional, default: `1m`)_ Maximum time before the scanning stops. This is specified as a time
103-
duration value, such as "1m" or "5s". The value must be between "1m" and
104-
"10m".
102+
- <a name="scan_timeout"></a><a href="#user-content-scan_timeout"><code>scan_timeout</code></a>: _(Optional, default: `3m`)_ The maximum time before the scanning stops. The value must be between "1m"
103+
and `10m`.
105104

106105
- <a name="ignore_violations"></a><a href="#user-content-ignore_violations"><code>ignore_violations</code></a>: _(Optional)_ Whether violations found in IaC file should be ignored when determining
107-
the build status. This input does not apply to violations that are related
106+
the build status. This input doesn't apply to violations that are related
108107
to generating SARIF reports and determining the `iac_scan_result`.
109108

110-
- <a name="failure_criteria"></a><a href="#user-content-failure_criteria"><code>failure_criteria</code></a>: _(Optional, default: `Critical:1, High:1, Medium:1, Low:1, Operator:OR`)_ Ffailure criteria that determines the workflow build status. You can set a
111-
threshold for the number of critical, high, medium, and low severity
109+
- <a name="failure_criteria"></a><a href="#user-content-failure_criteria"><code>failure_criteria</code></a>: _(Optional, default: `Critical:1, High:1, Medium:1, Low:1, Operator:OR`)_ The failure criteria that determines the workflow build status. You can
110+
set a threshold for the number of critical, high, medium, and low severity
112111
issues and use an aggregator (either `and` or `or`) to evaluate the
113112
criteria.
114113

115114
To determine whether a build has failed, the threshold for each severity
116115
is evaluated against the count of issues with that severity in the IaC
117116
scan results and then severity level evaluations are aggregated using
118-
`AND` or `OR` to arrive at `failure_criteria` value.
117+
`AND` or `OR` to arrive at `failure_criteria` value. You must include an
118+
aggregator in the string. The aggregator value is case-sensitive.
119+
120+
For example, if you set the failure criteria to `HIGH:1,LOW:1,OPERATOR:OR`,
121+
the workflow fails if there is 1 or more HIGH severity findings or 1 or
122+
more LOW severity findings. If you set the failure criteria to
123+
`HIGH:1,LOW:1,OPERATOR:AND`, the workflow fails if there is 1 or more HIGH
124+
severity findings and 1 or more LOW severity findings.
119125

120126
If the `failure_criteria` evaluates to `true`, the workflow is marked as
121127
`FAILED`. Otherwise, the workflow is marked as `SUCCESS`.
@@ -137,12 +143,12 @@ jobs:
137143
- `iac_scan_result`: The result of the security scan. One of:
138144

139145
- `passed`: No violations were found or the `failure_criteria` was not
140-
satisfied.
146+
satisfied.
141147

142148
- `failed`: The `failure_criteria` was satisfied.
143149

144150
- `error`: The action ran into an execution error, generally due to a
145-
misconfiguration or invalid credentials.
151+
misconfiguration or invalid credentials.
146152

147153
- `iac_scan_result_sarif_path`: Path for the SARIF report file. This file is only available when
148154
violations are found in the scan file.

dist/main/index.js

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@google-github-actions/analyze-code-security-scc",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "Provides functionality to scan code for vulnerability during the build step of the project.",
55
"main": "dist/main/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)