Search docs
Docs searchValidation rule
Back to Rule CatalogAP-SUP-001DocumentationSuppression reason missing
Checks that suppression entries include a reason.
warningviolationNo auto-fix
How to fix
- Add a clear reason.
- Include owner or review context where your workflow expects it.
- Prefer exceptions for governed temporary risk acceptance.
What the rule validates
A suppression exists without enough justification for future reviewers.
Why it matters
Suppressions hide findings, so each one needs accountable context.
Common causes
- A suppression was added quickly to unblock CI.
- The reason field was left blank.
- An old suppression format was copied.
Typical violation example
{ "ruleId": "AP-DEP-004", "reason": "" }Typical compliant example
{ "ruleId": "AP-DEP-004", "reason": "Temporary migration approved until scheduler boundary lands" }Related rules
AP-ADR-001 - ADR directory missingAP-ADR-002 - ADR file missing titleAP-ADR-003 - ADR status missing or invalidAP-ADR-004 - Required ADR missing for architecture context
Adjacent categories
Related files/config
.archpilot/suppressions.json.archpilot/exceptions.json
Related CLI commands
archpilot validatearchpilot validate --ci