Skip to content

Conversation

@jhjaggars
Copy link

This PR adds CLAUDE.md documentation to help with AI-assisted development.

Generated using Claude Code automation.

Generated using Claude Code automation to enhance AI-assisted development capabilities.
@openshift-ci
Copy link

openshift-ci bot commented Sep 18, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jhjaggars
Once this PR has been reviewed and has the lgtm label, please assign jgbernalp for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci
Copy link

openshift-ci bot commented Sep 18, 2025

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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
Copy link
Collaborator

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
Copy link
Collaborator

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
Copy link
Collaborator

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]>
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.

2 participants