updated documentation for default branch issue. (#1410)

Co-authored-by: Satyam Chaurasia <[email protected]>
checkmarx-ltd · Dec 10, 2024 · 98e3ea2 · 98e3ea2
1 parent 7163b51
commit 98e3ea2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -294,9 +294,11 @@ csv:
       name: severity
     - header: recommendation
       name: recommendation
+
 ```
 ### <a name="cli">CLI Examples</a>
 Examples to convert YAML property to CLI property
+
 ```
 #YAML
 cx-flow:
@@ -475,11 +477,13 @@ cx-flow:
 | `comment`                      |                | No                                                                   | No      | Yes          | User can store comments field in metadata about the scan.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | `overrideProjectSetting`       |                | No                                                                   | No      | Yes          | The utilization of this boolean variable empowers the user to restrict the override of project settings. By setting this variable, users can prevent any unauthorized alterations to the project's settings, ensuring stability and adherence to predefined configurations. This functionality serves as a safeguard against inadvertent or malicious changes that could potentially disrupt the project's operations. Thus, the boolean variable offers a valuable mechanism for maintaining the integrity and consistency of project settings, enhancing overall control and security within the system. Its implementation empowers users with the ability to govern and protect vital project parameters from unwarranted modifications. |
 | `enabledVulnerabilityScanners` | false          | No                                                                   | Yes     | Yes          | User can define which checkmarx tool they want to use like SAST, SCA or both.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `scanUnprotectedBranches` | false          | No                                                                   | Yes     | No           | If no branch list is provided for checking the protected branch and the user still wants their scan to occur, set this variable to true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | `deleteForkedProject`          | false          | No                                                                   | Yes     | No           | User can delete forked projects created on SAST portal.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | `delete-branched-project`      | false          | No                                                                   | Yes     | No           | User can delete branched project created on SAST portal.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `project-custom-field`         |                | No                                                                   | Yes     | No           | User can add multiple project-custom-field in SAST portal. `checkmarx.settings-override` property should be true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | `scan-custom-field`            |                | No                                                                   | Yes     | No           | User can add multiple scan-custom-field in SAST portal. `checkmarx.settings-override` property should be true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
+
 No* = Default is applied
 
 #### <a name="email">E-Mail notifications</a>