Skip to content

Add osde2e-common debugging guidelines to AGENTS.md#3229

Open
ritmun wants to merge 1 commit into
openshift:mainfrom
ritmun:add-agent-help
Open

Add osde2e-common debugging guidelines to AGENTS.md#3229
ritmun wants to merge 1 commit into
openshift:mainfrom
ritmun:add-agent-help

Conversation

@ritmun
Copy link
Copy Markdown
Contributor

@ritmun ritmun commented May 14, 2026

Documents workflow for debugging and fixing provisioning issues that
originate in vendored osde2e-common dependencies, including:

  • How to identify osde2e-common issues
  • Proper workflow (never edit vendor, use local replace)
  • Common error handling patterns to fix
  • Testing and PR submission process

@openshift-merge-bot
Copy link
Copy Markdown
Contributor

There are test jobs defined for this repository which are not configured to run automatically. Comment /test ? to see a list of all defined jobs. Review these jobs and use /test <job> to manually trigger jobs most likely to be impacted by the proposed changes.Comment /pipeline required to trigger all required & necessary jobs.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 7a31ede5-1976-499a-b2fb-104128432a3a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ 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 and usage tips.

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 14, 2026
Comment thread AGENTS.md Outdated
1. **Never edit vendor directory directly** - changes will be overwritten by `go mod vendor`
2. **Clone and fix in osde2e-common repo**:
```bash
cd /Users/rmundhe/GolandProjects/osde2e-common
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be good to provide a relative path, like ../osde2e-common

Copy link
Copy Markdown
Contributor

@christophermancini christophermancini left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label May 15, 2026
Comment thread AGENTS.md Outdated
When debugging provisioning or cluster lifecycle issues in osde2e that originate from osde2e-common:

### Identifying osde2e-common Issues
1. **Check vendor path**: Issues in `/vendor/github.com/openshift/osde2e-common/` indicate upstream problems
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/vendor/github.com/openshift/osde2e-common/
Is this your local path?

Copy link
Copy Markdown
Contributor Author

@ritmun ritmun May 15, 2026

Choose a reason for hiding this comment

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

per Claude,

Project-root notation: /vendor/ with a note that / means project root (common in some documentation styles)

For AGENTS.md, it should be changed to vendor/github.com/openshift/osde2e-common/ (without the leading slash) to avoid confusion, since it's describing a location within the repository.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

@ritmun
Copy link
Copy Markdown
Contributor Author

ritmun commented May 15, 2026

/override ci/prow/hypershift-pr-check

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 15, 2026

@ritmun: Overrode contexts on behalf of ritmun: ci/prow/hypershift-pr-check

Details

In response to this:

/override ci/prow/hypershift-pr-check

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.

@ritmun
Copy link
Copy Markdown
Contributor Author

ritmun commented May 15, 2026

/hold

@openshift-ci openshift-ci Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 15, 2026
  Documents workflow for debugging and fixing provisioning issues that
  originate in vendored osde2e-common dependencies, including:
  - How to identify osde2e-common issues
  - Proper workflow (never edit vendor, use local replace)
  - Common error handling patterns to fix
  - Testing and PR submission process
@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label May 15, 2026
@ritmun ritmun requested a review from varunraokadaparthi May 15, 2026 19:23
@YiqinZhang
Copy link
Copy Markdown
Contributor

/lgtm

@YiqinZhang
Copy link
Copy Markdown
Contributor

/override ci/prow/hypershift-pr-check

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label May 18, 2026
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 18, 2026

@YiqinZhang: Overrode contexts on behalf of YiqinZhang: ci/prow/hypershift-pr-check

Details

In response to this:

/override ci/prow/hypershift-pr-check

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.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 18, 2026

@ritmun: all tests passed!

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.

Copy link
Copy Markdown
Contributor

@YiqinZhang YiqinZhang left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 18, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christophermancini, ritmun, YiqinZhang

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 [YiqinZhang,christophermancini,ritmun]

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants