Skip to content

feat: add STP→tests cross-reference to CodeRabbit config - #148

Merged
rnetser merged 1 commit into
RedHatQE:mainfrom
rnetser:feat/coderabbit-stp-tests-crossref
Aug 4, 2026
Merged

feat: add STP→tests cross-reference to CodeRabbit config#148
rnetser merged 1 commit into
RedHatQE:mainfrom
rnetser:feat/coderabbit-stp-tests-crossref

Conversation

@rnetser

@rnetser rnetser commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a cross-reference mechanism to CodeRabbit so that meaningful STP changes flag potential test impact in RedHatQE/openshift-virtualization-tests.

This is the reverse link — the tests repo already has a linked_repositories entry pointing here for STP-to-test traceability. This PR adds the design-docs → tests direction.

Changes

path_instructions for stps/**

When an STP is modified, CodeRabbit classifies the change as meaningful or cosmetic:

  • Meaningful: scenario table changes (III), testing goals (II.1), requirements/acceptance criteria (I.1), scope, strategy, environment changes
  • Cosmetic: typos, formatting, sign-offs, metadata — skipped silently

For meaningful changes, it checks the linked tests repo:

  • Greenfield STPs (no tests reference this STP yet) → skip notice entirely
  • Confirmed misalignment (existing test contradicts updated STP) → HIGH informational comment
  • New scenario without test → MEDIUM advisory
  • Unconfirmed alignment → MEDIUM advisory

The cross-reference notice is non-blocking — STPs are the source of truth and tests catch up in follow-up PRs.

linked_repositories

Links to RedHatQE/openshift-virtualization-tests so CodeRabbit can look up existing test coverage.

review_details: true

Enables linked-repo context visibility in PR reviews (mirrors the tests repo config).

Template exclusion

Files under stps/stp-template/ are excluded from the cross-ref check.

Made with Cursor

Summary by CodeRabbit

  • Chores
    • Improved automated review guidance for STP-related changes.
    • Added instructions to cross-reference meaningful changes with tests and report coverage gaps.
    • Linked the OpenShift virtualization test repository as the source for test validation.

@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@rnetser, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: adc0a963-6478-4a30-9cd4-304edc246911

📥 Commits

Reviewing files that changed from the base of the PR and between cafb8bc and 76293a4.

📒 Files selected for processing (1)
  • .coderabbit.yaml
📝 Walkthrough

Walkthrough

This PR modifies .coderabbit.yaml. It enables review details and adds stps/** path instructions covering meaningful versus cosmetic STP changes, test mismatch and coverage-gap reporting, and non-blocking advisory behavior. It also links the RedHatQE/openshift-virtualization-tests repository for test cross-referencing.

Changes

Coderabbit Configuration Update

Layer / File(s) Summary
STP review guidance and linked test repository
.coderabbit.yaml
Enables review details. Adds stps/** instructions for meaningful-versus-cosmetic STP change detection, test mismatch reporting, and coverage-gap advisory behavior. Adds the RedHatQE/openshift-virtualization-tests linked repository for STP and test cross-referencing.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested labels: size/L

Suggested reviewers: dshchedr, vsibirsk

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding an STP-to-tests cross-reference in the CodeRabbit configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@openshift-virtualization-qe-bot-4

Copy link
Copy Markdown

Report bugs in Issues

Welcome! 🎉

This pull request will be automatically processed with the following features:

🔄 Automatic Actions

  • Reviewer Assignment: Reviewers are automatically assigned based on the OWNERS file in the repository root
  • Size Labeling: PR size labels (XS, S, M, L, XL, XXL) are automatically applied based on changes
  • Issue Creation: A tracking issue is created for this PR and will be closed when the PR is merged or closed
  • Branch Labeling: Branch-specific labels are applied to track the target branch
  • Auto-verification: Auto-verified users have their PRs automatically marked as verified
  • Labels: Enabled categories: branch, can-be-merged, cherry-pick, has-conflicts, hold, needs-rebase, size, verified, wip

📋 Available Commands

PR Status Management

  • /wip - Mark PR as work in progress (adds WIP: prefix to title)
  • /wip cancel - Remove work in progress status
  • /hold - Block PR merging (PR author or approvers)
  • /hold cancel - Unblock PR merging (PR author or approvers)
  • /verified - Mark PR as verified
  • /verified cancel - Remove verification status
  • /reprocess - Trigger complete PR workflow reprocessing (useful if webhook failed or configuration changed)
  • /regenerate-welcome - Regenerate this welcome message
  • /security-override - Set security check runs to pass (maintainers only)
  • /security-override cancel - Re-run security checks

Review & Approval

  • /lgtm - Approve changes (looks good to me)
  • /approve - Approve PR (approvers only)
  • /assign-reviewers - Assign reviewers based on OWNERS file
  • /assign-reviewer @username - Assign specific reviewer
  • /check-can-merge - Check if PR meets merge requirements

Testing & Validation

  • /retest tox - Run Python test suite with tox
  • /retest all - Run all available tests

Cherry-pick Operations

  • /cherry-pick <branch> - Schedule cherry-pick to target branch when PR is merged
    • Multiple branches: /cherry-pick branch1 branch2 branch3
  • /cherry-pick-retry <branch> - Retry a failed cherry-pick (merged PRs only)

Branch Management

  • /rebase - Rebase this PR branch onto its base branch

Label Management

  • /<label-name> - Add a label to the PR
  • /<label-name> cancel - Remove a label from the PR

✅ Merge Requirements

This PR will be automatically approved when the following conditions are met:

  1. Approval: /approve from at least one approver
  2. LGTM Count: Minimum 2 /lgtm from reviewers
  3. Status Checks: All required status checks must pass
  4. No Blockers: No wip, hold, has-conflicts labels and PR must be mergeable (no conflicts)

📊 Review Process

Approvers and Reviewers

Approvers:

  • rnetser

Reviewers:

  • rnetser
Available Labels
  • hold
  • verified
  • wip
  • lgtm
  • approve
AI Features
  • Cherry-Pick Conflict Resolution: Enabled (claude/claude-opus-4-6-1m)
Security Checks
  • Suspicious Path Detection: Monitors paths: .claude/, .vscode/, .cursor/, .devcontainer/, .pi/, .github/workflows/, .github/actions/
  • Committer Identity Check: Verifies last committer matches PR author
  • Mandatory: Security checks block merge (use /security-override to bypass — maintainers only)

💡 Tips

  • WIP Status: Use /wip when your PR is not ready for review
  • Verification: The verified label is removed on new commits unless the push is detected as a clean rebase
  • Cherry-picking: Cherry-pick labels are processed when the PR is merged
  • Permission Levels: Some commands require approver permissions
  • Auto-verified Users: Certain users have automatic verification and merge privileges

For more information, please refer to the project documentation or contact the maintainers.

Add path_instructions for stps/** that flags meaningful STP changes
(scenarios, goals, criteria, scope) for potential test impact in
RedHatQE/openshift-virtualization-tests. Cosmetic changes (typos,
formatting) are skipped.

Key behaviors:
- Greenfield STPs (no existing test refs) skip cross-ref entirely
- Confirmed misalignment with existing tests: HIGH (informational)
- New scenarios without tests / unconfirmed alignment: MEDIUM advisory
- Cross-ref notice is non-blocking (STPs are source of truth)
- Template files (stps/stp-template/) excluded

Also adds linked_repositories pointing to the tests repo and enables
review_details for linked-repo visibility.

Signed-off-by: rnetser <rnetser@redhat.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Assisted-by: Claude <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@rnetser
rnetser force-pushed the feat/coderabbit-stp-tests-crossref branch from cafb8bc to 76293a4 Compare August 4, 2026 09:30

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.coderabbit.yaml:
- Around line 70-100: The advisory CrossReference review path in the CodeRabbit
configuration must not use request_changes_workflow. Update the relevant
workflow setting near the existing configuration at line 18 to disable
request_changes_workflow or select a supported non-review reporting path, while
preserving the non-blocking behavior described for the CrossReference notices.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f66cccb1-e05e-4b2c-b2b5-daccd5f4a42f

📥 Commits

Reviewing files that changed from the base of the PR and between 5665a7d and cafb8bc.

📒 Files selected for processing (1)
  • .coderabbit.yaml

Comment thread .coderabbit.yaml Outdated
@rnetser

rnetser commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

/approve
/lgtm

@rnetser
rnetser merged commit ce13683 into RedHatQE:main Aug 4, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants