Skip to content

Commit 09eebe3

Browse files
committed
add threshold and rule disable sections
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent a7159bf commit 09eebe3

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/howto-6-policy-rules-configuration.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,23 @@ For the **Vulnerability Stale** rule, two parameters are available:
5252
unaddressed before the package is flagged. Defaults to 30.
5353
- :guilabel:`Min Risk Score`: only vulnerabilities at or above this score are
5454
considered. Defaults to 8.0.
55+
56+
4. Set a Threshold
57+
------------------
58+
59+
By default, a single violation is enough to trigger a rule. The :guilabel:`Threshold`
60+
field lets you tolerate a certain number of violations before a triggered state is
61+
recorded. Violations are only recorded when the count strictly exceeds the threshold.
62+
63+
For example, setting a threshold of 2 on the **License Coverage Gap** rule means the
64+
rule is only triggered when more than 2 packages have no license expression.
65+
66+
This is useful when a small number of violations is acceptable during onboarding or
67+
remediation phases.
68+
69+
5. Disable a Rule
70+
-----------------
71+
72+
To disable a rule, uncheck its :guilabel:`Enable this rule` checkbox and save. Any
73+
currently open violations for that rule are automatically resolved and will no longer
74+
appear in the compliance tab.

0 commit comments

Comments
 (0)