Skip to content

Document the severity scale for compliance violations

Problem to solve

With the severity levels added to the compliance report, there is no one place users can visit to see what types of violations can be produced and the severity level that they are attributed to.

Proposal

Add to the compliance report documentation two tables:

  • A table of the severity levels with their icon
  • A table of the violations produced that are currently implemented
  • A table of the violations produced that are planned to be implemented
Icon Severity rating
Severity_status Critical
Severity_status-1 High
Severity_status-2 Medium
Severity_status-3 Low
Severity_status-4 Info
Violation Severity rating Category Description Implemented in version
Author approved MR Severity_status-1 Separation of duties Describe what this is. Any doc links? %14.9
Committer(s) approved MR Severity_status-1 Separation of duties Describe what this is. Any doc links? %14.9
Less than 2 approvals Severity_status-1 Separation of duties Describe what this is. Any doc links? %14.9
Violation Severity rating Category Description
Code coverage down > 10% Severity_status-1 Code coverage > 75% Describe what this is. Any doc links?
Failed Severity_status-2 Pipeline results Describe what this is. Any doc links?
Code coverage down > 5-10% Severity_status-2 Code coverage > 75% Describe what this is. Any doc links?
Code coverage down > 1-5% Severity_status-3 Code coverage > 75% Describe what this is. Any doc links?
Passed with warnings Severity_status-4 Pipeline results Describe what this is. Any doc links?
Code coverage down < 1% Severity_status-4 Code coverage > 75% Describe what this is. Any doc links?
Edited by Robert Hunt