You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ jobs:
86
86
<!-- BEGIN_AUTOGEN_INPUTS -->
87
87
88
88
- <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'.
90
90
91
91
- <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.
92
92
For example:
@@ -97,25 +97,31 @@ jobs:
97
97
98
98
./artifacts/tf_plan.json
99
99
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.
101
101
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`.
105
104
106
105
- <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
108
107
to generating SARIF reports and determining the `iac_scan_result`.
109
108
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
112
111
issues and use an aggregator (either `and` or `or`) to evaluate the
113
112
criteria.
114
113
115
114
To determine whether a build has failed, the threshold for each severity
116
115
is evaluated against the count of issues with that severity in the IaC
117
116
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.
119
125
120
126
If the `failure_criteria` evaluates to `true`, the workflow is marked as
121
127
`FAILED`. Otherwise, the workflow is marked as `SUCCESS`.
@@ -137,12 +143,12 @@ jobs:
137
143
- `iac_scan_result`: The result of the security scan. One of:
138
144
139
145
- `passed`: No violations were found or the `failure_criteria` was not
140
-
satisfied.
146
+
satisfied.
141
147
142
148
- `failed`: The `failure_criteria` was satisfied.
143
149
144
150
- `error`: The action ran into an execution error, generally due to a
145
-
misconfiguration or invalid credentials.
151
+
misconfiguration or invalid credentials.
146
152
147
153
- `iac_scan_result_sarif_path`: Path for the SARIF report file. This file is only available when
0 commit comments