OCM-19812: Improve local development documentation#569
OCM-19812: Improve local development documentation#569Alcamech wants to merge 1 commit intoopenshift:masterfrom
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@Alcamech: This pull request references OCM-19812 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Alcamech The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
LGTM |
WalkthroughThe Development documentation file underwent structural reorganization, consolidating multiple nested sections into simplified top-level headings: "Development Environment Setup," "Running Locally," and "Running Remotely." Command formatting was standardized by removing shell prompts, and content was streamlined by removing detailed subsections and consolidating instructions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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. Comment |
|
@Alcamech: This pull request references OCM-19812 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/development.md`:
- Around line 91-95: The documentation shows inconsistent test commands: the
prose says "make test" but the code block uses "make go-test"; update the docs
so both prose and the code block use the same command (choose either "make test"
or "make go-test") and make the change in the docs/development.md text
surrounding the testing instruction so the sentence and the fenced shell snippet
match (look for the lines containing "make test" and the code block with "make
go-test").
ℹ️ Review info
Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
docs/development.md
| To run unit tests locally, call `make test` | ||
|
|
||
| ```shell | ||
| $ make go-test | ||
| make go-test | ||
| ``` |
There was a problem hiding this comment.
Fix command mismatch in testing instructions.
Line 91 says to run make test, but Line 94 shows make go-test. Please make prose and command consistent to avoid confusion.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/development.md` around lines 91 - 95, The documentation shows
inconsistent test commands: the prose says "make test" but the code block uses
"make go-test"; update the docs so both prose and the code block use the same
command (choose either "make test" or "make go-test") and make the change in the
docs/development.md text surrounding the testing instruction so the sentence and
the fenced shell snippet match (look for the lines containing "make test" and
the code block with "make go-test").
|
@Alcamech: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
3 participants
What type of PR is this?
Documentation
What this PR does / why we need it?
Updates the local
development.mddocumentation to:UpgradeConfigSyncFailureOver4HrSREto ignoredCriticals in the test ConfigMap (this alert fires when the deployed MUO is scaled down)
OSDK_FORCE_RUN_MODE=localrequirement for routes (both env vars are needed)Which Jira/Github issue(s) this PR fixes?
Fixes OCM-19812
Summary by CodeRabbit