Merge pull request #3 from Qualys/release/1.0.2

Release/1.0.2

Author: kebhosale

README.md

@@ -176,6 +176,38 @@ jobs:
 3. `Qualys URL, Qualys Username , Qualys Password` to be added in `secrets` and provided as `environment variables` to the Qualys IaC GitHub action.
 4. Self-hosted runners must use a Linux operating system and have Docker installed to run this action.
 
+## Optional environment variable
+| Parameter  | Description | Required | Default Value | Parameter Type |
+| -----------| -------------------------------------------------------------------------------------------------------- | ------------- | ------------- | ------------- |
+| 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 |
+
+### Example - `failBuild` set to `false`
+```yaml
+name: Qualys IAC Scan 
+on:
+  push:
+    branches:
+      - main
+jobs:
+    Qualys_iac_scan:
+        runs-on: ubuntu-latest
+        name: Qualys IaC Scan
+        steps:
+          - name: Checkout
+            uses: actions/checkout@v2 
+            with:
+                fetch-depth: 0
+    
+          - name: Qualys IAC scan action step
+            uses: Qualys/github_action_qiac@main
+            id: qiac
+            env:
+                URL: ${{ secrets.URL }}
+                UNAME: ${{ secrets.USERNAME }}
+                PASS: ${{ secrets.PASSWORD }}
+                failBuild: false
+```
+
 ## GitHub action Parameters
 
 | Parameter  | Description | Required | Default | Type |

resultParser.py

@@ -1,4 +1,4 @@
-import sys, json
+import sys, json, os 
 
 def print_error_message(result):
     error_message = ""
@@ -32,9 +32,13 @@ def print_failed_checks(output):
     failed_checks = False
     for result in output.get("result"):
         failed_checks = print_error_message(result)
+    failBuild = os.getenv("failBuild", "true").lower() == "true"
     if failed_checks:
-        exit(-1)
-
+        if failBuild :
+            print("Pipeline status will be - Failed")
+            exit(-1)
+        else:
+            print("Pipeline status will be - Successful")
 
 # Press the green button in the gutter to run the script.
 if __name__ == '__main__':