-
Notifications
You must be signed in to change notification settings - Fork 70
Add CLAUDE.md documentation #880
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Generated using Claude Code automation to enhance AI-assisted development capabilities.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: jhjaggars The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Hi @jhjaggars. Thanks for your PR. I'm waiting for a rhobs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
CLAUDE.md
Outdated
| - `make operator` - Generate manifests and build operator binary (default target) | ||
| - `make build` - Build operator binary to `./tmp/operator` | ||
| - `make operator-image` - Build operator container image | ||
| - `go run ./cmd/operator/... --zap-devel --zap-log-level=100 --kubeconfig ~/.kube/config` - Run operator locally |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you test this? Not sure that is correct.
CLAUDE.md
Outdated
| **Key Dependencies**: | ||
| - Uses forked prometheus-operator (`github.com/rhobs/obo-prometheus-operator`) for compatibility | ||
| - Integrates with OpenShift APIs for console UI plugins | ||
| - Built on controller-runtime v0.21.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's not hardcode the version, its subject to change.
CLAUDE.md
Outdated
|
|
||
| ## Development Notes | ||
|
|
||
| - Requires OLM (Operator Lifecycle Manager) for proper operation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is not correct, you can install it manually as well. We just often rely on OLM to install things
Address PR review comments: - Replace abstract "go run" instruction with complete 5-step process - Add exact commands for building, deploying, and running operator locally - Remove hardcoded controller-runtime version (v0.21.0) - Clarify that OLM is commonly used but not strictly required - Include proper kubeconfig flag and output redirection in go run command The original single-line go run command failed without prerequisites. Now provides copy-pasteable commands that actually work. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
This PR adds CLAUDE.md documentation to help with AI-assisted development.
Generated using Claude Code automation.