Skip to content

Commit 07f6cb1

Browse files
authored
Update README.md
1 parent 0ab5f6a commit 07f6cb1

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,38 @@ jobs:
176176
3. `Qualys URL, Qualys Username , Qualys Password` to be added in `secrets` and provided as `environment variables` to the Qualys IaC GitHub action.
177177
4. Self-hosted runners must use a Linux operating system and have Docker installed to run this action.
178178

179+
## Optional environment variable
180+
| Parameter | Description | Required | Default Value | Parameter Type |
181+
| -----------| -------------------------------------------------------------------------------------------------------- | ------------- | ------------- | ------------- |
182+
| failBuild | This parameter enables marking the workflow as failed or successful based on user input.<br> <b>Parameter Behavior:</b><br><ol><li><b>true -</b><ul><li>If the control check fails → the workflow will be marked as Failed</li><li>If the control check passes → the workflow will be marked as Passed</li></ul></li><li><b>false -</b><ul><li>The workflow will always be marked as Passed, regardless of whether the control check passes or fails.</li></ul></li></ol> | No | true | Variable |
183+
184+
### Example - `failBuild` set to `false`
185+
```yaml
186+
name: Qualys IAC Scan
187+
on:
188+
push:
189+
branches:
190+
- main
191+
jobs:
192+
Qualys_iac_scan:
193+
runs-on: ubuntu-latest
194+
name: Qualys IaC Scan
195+
steps:
196+
- name: Checkout
197+
uses: actions/checkout@v2
198+
with:
199+
fetch-depth: 0
200+
201+
- name: Qualys IAC scan action step
202+
uses: Qualys/github_action_qiac@main
203+
id: qiac
204+
env:
205+
URL: ${{ secrets.URL }}
206+
UNAME: ${{ secrets.USERNAME }}
207+
PASS: ${{ secrets.PASSWORD }}
208+
failBuild: false
209+
```
210+
179211
## GitHub action Parameters
180212

181213
| Parameter | Description | Required | Default | Type |

0 commit comments

Comments
 (0)