Commit d704522
fix: enforce
##### What this PR does / why we need it:
The project's jira-utils checker validates Jira IDs across the codebase.
When test docstrings include `Jira:` lines for traceability (not
quarantine/xfail), those references trigger false positives unless they
have a `# <skip-jira-utils-check>` inline comment.
This PR:
1. Adds a **Jira skip-marker enforcement** instruction to the
`.coderabbit.yaml` "STP link required" custom check, so CodeRabbit flags
any `Jira:` line in test docstrings that is missing `#
<skip-jira-utils-check>` (HIGH severity). Only applies to `Jira:` lines
— `STP:` and `RFE:` lines are unaffected.
2. Fixes the one existing violation in
`tests/observability/metrics/test_vms_metrics.py`.
##### Which issue(s) this PR fixes:
Fixes #5257
##### Special notes for reviewer:
##### jira-ticket:
NONE
Co-authored-by: Claude <noreply@anthropic.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Chores**
* Updated the code review configuration to strengthen
documentation/traceability enforcement for newly added test docstrings,
specifically requiring a Jira inline “skip” marker when a Jira
traceability line is present.
* **Documentation**
* Added the required Jira skip directive to a test docstring to satisfy
the updated traceability rule.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Signed-off-by: Ruth Netser <rnetser@redhat.com>
Co-authored-by: Claude <noreply@anthropic.com># <skip-jira-utils-check> on Jira lines in CodeRabbit config (#5258)1 parent 4a3345c commit d704522
2 files changed
Lines changed: 10 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
121 | 121 | | |
122 | 122 | | |
123 | 123 | | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
124 | 133 | | |
125 | 134 | | |
126 | 135 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
551 | 551 | | |
552 | 552 | | |
553 | 553 | | |
554 | | - | |
| 554 | + | |
555 | 555 | | |
556 | 556 | | |
557 | 557 | | |
| |||
0 commit comments