NO-JIRA: Add coderabbit, including instructions

[dfajmon]

Coderabbit is an AI review tool that is accepted in OpenShift Org. If we want to efficiently use it we should have a config file. I have also added basic instructions that are useful for CodeRabbit, but could be used for Claude too.

[openshift-ci-robot]

@dfajmon: This pull request explicitly references no jira issue.

Details

In response to this:

Coderabbit is an AI review tool that is accepted in OpenShift Org. If we want to efficiently use it we should have a config file. I have also added basic instructions that are useful for CodeRabbit, but could be used for Claude too.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[dfajmon]

@coderabbitai sum up changes

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@dfajmon, let me gather the details of the changes in this PR.

---

🏁 Script executed:

#!/bin/bash
# Get the list of files changed in PR `#509`
gh pr view 509 --json files --jq '.files[] | "\(.path) (\(.additions)+/\(.deletions)-)"'

echo "---"
echo "Fetching file contents:"
echo "---"

# Get the diff to see what was added
gh pr diff 509

Length of output: 6472

---

@dfajmon, here's a summary of the changes in this PR:

Summary

This PR adds two new files to configure and guide AI-powered code reviews:

1. .coderabbit.yaml (24 lines)

CodeRabbit configuration file that:

• Sets review profile to "chill" (less aggressive reviewing)
• Enables review status and commit status tracking
• Disables optional features (poems, effort estimates, sequence diagrams, etc.)
• Excludes vendor/** from reviews using path filters
• Enables golangci-lint integration
• Configures knowledge base to use AGENTS.md as code guidelines
• Sets learnings scope to local (repository-specific)

2. AGENTS.md (159 lines)

Comprehensive guidance document for AI agents covering:

• Repository Overview: OpenShift CSI Operator monorepo structure
• Asset Generation System: Template processing, ClusterFlavour concepts, patching strategies
• Operator Structure: Controllers, hooks, and driver-specific customization
• CSI Sidecars: Standard Kubernetes components used
• Development Commands: Build, asset generation, verification, metadata updates
• Conventions: Port allocation registry, namespace patterns, resource naming
• Development Notes: HyperShift support, cloud credentials, metrics, images

This setup enables CodeRabbit (and other AI tools) to provide context-aware code reviews with deep understanding of the repository's architecture, conventions, and development workflows.

[dfajmon]

@coderabbitai why was the automatic review skippe?

[coderabbitai]

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the list of files changed in this PR
echo "=== Files changed in PR `#509` ==="
gh pr view 509 --json files --jq '.files[] | .path'

echo ""
echo "=== Checking if .coderabbit.yaml exists and its content ==="
if [ -f .coderabbit.yaml ]; then
    cat .coderabbit.yaml
else
    echo ".coderabbit.yaml not found in current branch"
fi

echo ""
echo "=== Checking if AGENTS.md exists ==="
if [ -f AGENTS.md ]; then
    echo "AGENTS.md exists ($(wc -l < AGENTS.md) lines)"
else
    echo "AGENTS.md not found in current branch"
fi

echo ""
echo "=== PR details ==="
gh pr view 509 --json title,body,labels,isDraft,mergeable

Length of output: 1366

---

🏁 Script executed:

#!/bin/bash
# Check for CodeRabbit-related comments or status checks
echo "=== PR Comments ==="
gh pr view 509 --json comments --jq '.comments[] | select(.author.login == "coderabbitai" or .author.login == "coderabbitai[bot]") | {author: .author.login, createdAt: .createdAt, body: .body}'

echo ""
echo "=== PR Status Checks ==="
gh pr view 509 --json statusCheckRollup --jq '.statusCheckRollup[] | select(.name | contains("coderabbit") or contains("CodeRabbit")) | {name: .name, state: .state, conclusion: .conclusion}'

echo ""
echo "=== All Status Checks ==="
gh pr view 509 --json statusCheckRollup --jq '.statusCheckRollup[].name' | head -20

Length of output: 2365

---

@dfajmon, the automatic review was skipped because this PR only adds CodeRabbit's own configuration files:

1. .coderabbit.yaml - CodeRabbit's configuration file
2. AGENTS.md - Documentation/guidelines for AI agents

CodeRabbit intentionally skips automatic reviews for PRs that solely modify its own configuration or documentation files to avoid circular behavior and unnecessary reviews of meta-configuration changes.

If you'd like me to review these files anyway (to check YAML syntax, validate the configuration structure, or review the documentation content), just let me know and I can trigger a manual review using the `` action.

Alternatively, once this PR is merged, CodeRabbit will start using this configuration for all future PRs automatically, reviewing actual code changes with the settings you've defined (chill profile, golangci-lint integration, AGENTS.md as guidelines, etc.).

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request adds two new files. The .coderabbit.yaml file configures CodeRabbit settings: language, review profile and flags, path_filters excluding vendor, enabled golangci-lint tooling, and a knowledge_base section for AGENTS.md and local learnings. The AGENTS.md file documents the OpenShift CSI Operator monorepo: asset generation workflow, templates and overlays, cluster flavours, patching strategies, operator structure and controllers, CSI sidecars, development commands (build/clean/update/verify), embedding assets, and repository conventions for ports, namespaces, naming, and code organization.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'NO-JIRA: Add coderabbit, including instructions' clearly and concisely describes the main change: adding CodeRabbit configuration and documentation files to the repository.
Description check	✅ Passed	The description is directly related to the changeset, explaining that CodeRabbit is being added with a config file and instructions for use, and mentions the two files being introduced.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

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

[dfajmon]

/retest

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (1)

AGENTS.md (1)

81-81: ⚠️ Potential issue | 🟡 Minor

Address the past review comment for improved accuracy.

A previous reviewer (jsafrane) suggested making the template path more specific. The current description states templates come from assets/, but the suggested change specifies assets/overlays/<driver> which better aligns with the architecture described earlier in the document (lines 17-18).

📝 Suggested improvement

-This runs the generator which processes driver configurations from `pkg/driver/*/` and templates from `assets/` to generate final manifests in `assets/overlays/<driver>/generated`.
+This runs the generator which processes driver configurations from `pkg/driver/*/` and templates from `assets/overlays/<driver>` to generate final manifests in `assets/overlays/<driver>/generated`.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` at line 81, Update the sentence that currently says templates come
from "assets/" to instead state they come from "assets/overlays/<driver>" so the
description reads that the generator processes driver configurations from
"pkg/driver/*/" and templates from "assets/overlays/<driver>" to produce final
manifests in "assets/overlays/<driver>/generated"; make this wording consistent
with the earlier architecture description in the document.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Line 110: Reword the sentence to clearly state that you must always check the
port registry before assigning new ports, and make explicit that this check is
especially important for pods using hostNetwork: true; update the line
referencing "nodes using `hostNetwork: true`" to instead say something like
"pods using `hostNetwork: true`" and ensure the sentence clearly links the port
registry check to avoiding port collisions on the host.
- Around line 106-108: Update AGENTS.md to clarify that only metrics ports are
registered in pkg/driver/common/generator/port_registry.go while liveness probe
ports (e.g., 10300 used by azure-disk, aws-ebs, openstack-cinder) are currently
hardcoded in their individual driver files; either document this distinction
explicitly (preferred) or move the liveness probe port allocations into the
registry (alternative) and update the text to reflect whichever approach you
implement so the doc and code remain consistent.

---

Duplicate comments:
In `@AGENTS.md`:
- Line 81: Update the sentence that currently says templates come from "assets/"
to instead state they come from "assets/overlays/<driver>" so the description
reads that the generator processes driver configurations from "pkg/driver/*/"
and templates from "assets/overlays/<driver>" to produce final manifests in
"assets/overlays/<driver>/generated"; make this wording consistent with the
earlier architecture description in the document.

---

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 042df46 and 26723ce.

📒 Files selected for processing (2)

• .coderabbit.yaml
• AGENTS.md

🚧 Files skipped from review as they are similar to previous changes (1)

• .coderabbit.yaml

[dfajmon]

/retest

[jsafrane]

/lgtm
/approve

[jsafrane]

/verified by jsafrane

[openshift-ci-robot]

@jsafrane: This PR has been marked as verified by jsafrane.

Details

In response to this:

/verified by jsafrane

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dfajmon, jsafrane

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [dfajmon,jsafrane]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[Phaow]

/retest-required

[dfajmon]

/retest-required

[dfajmon]

/retest

[dfajmon]

/retest

[openshift-ci]

@dfajmon: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/hypershift-e2e-aks	24d89b6	link	true	/test hypershift-e2e-aks

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.