fix: Update CodeRabbit configuration instructions

[myakove]

• Update outdated path: scripts/resource → class_generator
• Improve instructions for clarity and actionability

Summary by CodeRabbit

• Chores
  • Updated internal code review configuration to optimize review processes for generated code sections.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

A path instruction entry is added to .coderabbit.yaml to skip code review for files within **/ocp_resources/**/ directories between generated-code markers. The configuration specifies that only code outside these markers should be reviewed, with violations flagged when generated sections are directly edited.

Changes

Cohort / File(s)	Summary
Review Configuration \.coderabbit\.yaml	Added path_instructions entry to skip reviewing auto-generated code in ocp_resources directories between generated-code markers; directs edits to class-generator tool instead

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Straightforward configuration addition with no logic changes or functional impact

Suggested reviewers

• rnetser
• omrirh
• dbasunag

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is largely incomplete, missing most required template sections like detailed explanations, issue references, and special notes for reviewers.	Complete the PR description by filling in the template sections: add more details, reference the specific issue(s), and include any special notes for reviewers.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: updating CodeRabbit configuration instructions for path and clarity improvements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/coderabbit-path-instructions

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 891dd05 and e71aa6c.

📒 Files selected for processing (1)

• .coderabbit.yaml (1 hunks)

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: myakove
Repo: RedHatQE/openshift-python-wrapper PR: 2209
File: ocp_resources/volume_snapshot_class.py:0-0
Timestamp: 2024-12-03T08:02:11.880Z
Learning: In generated code files like `ocp_resources/volume_snapshot_class.py`, avoid suggesting adding validation checks or modifications, as generated code should not be manually altered.

📚 Learning: 2024-12-03T08:02:11.880Z

Learnt from: myakove
Repo: RedHatQE/openshift-python-wrapper PR: 2209
File: ocp_resources/volume_snapshot_class.py:0-0
Timestamp: 2024-12-03T08:02:11.880Z
Learning: In generated code files like `ocp_resources/volume_snapshot_class.py`, avoid suggesting adding validation checks or modifications, as generated code should not be manually altered.

Applied to files:

• .coderabbit.yaml

📚 Learning: 2024-10-08T23:43:22.342Z

Learnt from: sbahar619
Repo: RedHatQE/openshift-python-wrapper PR: 2126
File: ocp_resources/user_defined_network.py:19-19
Timestamp: 2024-10-08T23:43:22.342Z
Learning: When reviewing code generated by the class generator, avoid suggesting changes that would alter its automatic version.

Applied to files:

• .coderabbit.yaml

📚 Learning: 2024-10-09T14:25:49.618Z

Learnt from: myakove
Repo: RedHatQE/openshift-python-wrapper PR: 2152
File: class_generator/tests/manifests/ServingRuntime/serving_runtime.py:96-160
Timestamp: 2024-10-09T14:25:49.618Z
Learning: The code in the `class_generator/tests/manifests/ServingRuntime/serving_runtime.py` file is auto-generated. Avoid suggesting refactoring changes to auto-generated code in this path.

Applied to files:

• .coderabbit.yaml

📚 Learning: 2024-10-09T14:23:46.600Z

Learnt from: myakove
Repo: RedHatQE/openshift-python-wrapper PR: 2152
File: class_generator/tests/manifests/ServingRuntime/serving_runtime.py:9-10
Timestamp: 2024-10-09T14:23:46.600Z
Learning: In the file `class_generator/tests/manifests/ServingRuntime/serving_runtime.py`, the `ServingRuntime` class is auto-generated code. Do not request adding descriptions to docstrings when reviewing auto-generated code containing placeholders like "No field description from API; please add description."

Applied to files:

• .coderabbit.yaml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

• GitHub Check: can-be-merged
• GitHub Check: can-be-merged
• GitHub Check: can-be-merged
• GitHub Check: python-module-install
• GitHub Check: conventional-title
• GitHub Check: tox

🔇 Additional comments (2)

.coderabbit.yaml (2)

19-30: LGTM! Clear instructions for handling auto-generated code.

The configuration correctly specifies how to handle auto-generated code in the ocp_resources directories. The instructions are clear, actionable, and align with the learnings about not modifying generated code.

Based on learnings, this approach prevents suggesting changes to auto-generated code files.

---

22-24: Correct the start marker path in .coderabbit.yaml to match actual generated files.

The start marker specified on line 23 references class_generator/README.md, but all generated files in ocp_resources/ use scripts/resource/README.md. Update the marker to:

- Start: `# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md`

Without this fix, CodeRabbit will not correctly identify generated code sections for skipping review.

⛔ Skipped due to learnings

Learnt from: myakove
Repo: RedHatQE/openshift-python-wrapper PR: 2209
File: ocp_resources/volume_snapshot_class.py:0-0
Timestamp: 2024-12-03T08:02:11.880Z
Learning: In generated code files like `ocp_resources/volume_snapshot_class.py`, avoid suggesting adding validation checks or modifications, as generated code should not be manually altered.

Learnt from: myakove
Repo: RedHatQE/openshift-python-wrapper PR: 2152
File: class_generator/tests/manifests/ServingRuntime/serving_runtime.py:96-160
Timestamp: 2024-10-09T14:25:49.618Z
Learning: The code in the `class_generator/tests/manifests/ServingRuntime/serving_runtime.py` file is auto-generated. Avoid suggesting refactoring changes to auto-generated code in this path.

Learnt from: myakove
Repo: RedHatQE/openshift-python-wrapper PR: 2152
File: class_generator/tests/manifests/ServingRuntime/serving_runtime.py:9-10
Timestamp: 2024-10-09T14:23:46.600Z
Learning: In the file `class_generator/tests/manifests/ServingRuntime/serving_runtime.py`, the `ServingRuntime` class is auto-generated code. Do not request adding descriptions to docstrings when reviewing auto-generated code containing placeholders like "No field description from API; please add description."

Learnt from: sbahar619
Repo: RedHatQE/openshift-python-wrapper PR: 2126
File: ocp_resources/user_defined_network.py:19-19
Timestamp: 2024-09-29T12:43:09.926Z
Learning: When reviewing code generated by the class generator, avoid suggesting changes that would alter its automatic version.

Learnt from: sbahar619
Repo: RedHatQE/openshift-python-wrapper PR: 2126
File: ocp_resources/user_defined_network.py:19-19
Timestamp: 2024-10-08T23:43:22.342Z
Learning: When reviewing code generated by the class generator, avoid suggesting changes that would alter its automatic version.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[rh-bot-1]

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
• Pre-commit Checks: pre-commit runs automatically if .pre-commit-config.yaml exists
• Branch Labeling: Branch-specific labels are applied to track the target branch
• Auto-verification: Auto-verified users have their PRs automatically marked as verified

📋 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 (approvers only)
• /hold cancel - Unblock PR merging
• /verified - Mark PR as verified
• /verified cancel - Remove verification status
• /reprocess - Trigger complete PR workflow reprocessing (useful if webhook failed or configuration changed)

Review & Approval

• /lgtm - Approve changes (looks good to me)
• /approve - Approve PR (approvers only)
• /automerge - Enable automatic merging when all requirements are met (maintainers and 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 python-module-install - Test Python package installation
• /retest conventional-title - Validate commit message format
• /retest all - Run all available tests

Container Operations

• /build-and-push-container - Build and push container image (tagged with PR number)
  • Supports additional build arguments: /build-and-push-container --build-arg KEY=value

Cherry-pick Operations

• /cherry-pick <branch> - Schedule cherry-pick to target branch when PR is merged
  • Multiple branches: /cherry-pick branch1 branch2 branch3

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 0 /lgtm from reviewers
3. Status Checks: All required status checks must pass
4. No Blockers: No WIP, hold, or conflict labels
5. Verified: PR must be marked as verified (if verification is enabled)

📊 Review Process

Approvers and Reviewers

Approvers:

• myakove
• rnetser

Reviewers:

• myakove
• rnetser

Available Labels

• hold
• verified
• wip
• lgtm
• approve
• automerge

💡 Tips

• WIP Status: Use /wip when your PR is not ready for review
• Verification: The verified label is automatically removed on each new commit
• Cherry-picking: Cherry-pick labels are processed when the PR is merged
• Container Builds: Container images are automatically tagged with the PR number
• 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.

[myakove]

/verified

[rnetser]

/approve
/lgtm