[SREP-4818] docs: add intructions to install with Homebrew#939
Conversation
openshift-ci
Bot
added
the
tide/merge-method-squash
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: gvnnn 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 |
WalkthroughThe PR updates the ChangesInstallation Documentation Improvements
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 12✅ Passed checks (12 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 14-22: The README currently implies Go 1.19 is a global
prerequisite; restrict the Go prerequisite to source builds by moving or
duplicating the Go 1.19 requirement into the "Build from source" section and
removing it from top-level or MacOS install instructions (specifically update
the "MacOS" section and the global prerequisites so Homebrew install example for
backplane-cli doesn't imply Go is required); ensure the "Build from source"
heading explicitly lists "Go 1.19" and any build steps that require it so users
installing via Homebrew or downloads aren't misled.
- Line 14: Update the user-facing heading text that currently reads "MacOS" to
use the official product casing "macOS" in the README (change the heading line
with "### MacOS" to "### macOS") so documentation is consistent with product
naming.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 305a46af-7974-4b42-a50e-5d0041e8d4cf
📒 Files selected for processing (1)
README.md
| ### MacOS | ||
|
|
||
| ```brew | ||
| brew install backplane-cli | ||
| ``` | ||
|
|
||
|
|
||
| ### Download from release | ||
|
|
There was a problem hiding this comment.
Scope the Go prerequisite to source builds only.
With Homebrew install added, the global Go 1.19 prerequisite is misleading. Go is only required for “Build from source.”
Suggested fix
-Go should be installed in your local system with version 1.19
+For building from source, Go should be installed locally (minimum version 1.19).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 14 - 22, The README currently implies Go 1.19 is a
global prerequisite; restrict the Go prerequisite to source builds by moving or
duplicating the Go 1.19 requirement into the "Build from source" section and
removing it from top-level or MacOS install instructions (specifically update
the "MacOS" section and the global prerequisites so Homebrew install example for
backplane-cli doesn't imply Go is required); ensure the "Build from source"
heading explicitly lists "Go 1.19" and any build steps that require it so users
installing via Homebrew or downloads aren't misled.
| Go should be installed in your local system with version 1.19 | ||
|
|
||
| ### Option 1: Download from release | ||
| ### MacOS |
There was a problem hiding this comment.
Use official product casing: macOS.
MacOS should be macOS for user-facing documentation consistency.
Suggested fix
-### MacOS
+### macOS📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### MacOS | |
| ### macOS |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 14, Update the user-facing heading text that currently
reads "MacOS" to use the official product casing "macOS" in the README (change
the heading line with "### MacOS" to "### macOS") so documentation is consistent
with product naming.
|
@gvnnn: The following test failed, say
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. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #939 +/- ##
==========================================
- Coverage 54.02% 53.99% -0.04%
==========================================
Files 82 82
Lines 6323 6323
==========================================
- Hits 3416 3414 -2
- Misses 2462 2463 +1
- Partials 445 446 +1 🚀 New features to boost your workflow:
|
2 participants
What type of PR is this?
What this PR does / Why we need it?
backplane-cliis now available within Homebrew, therefore instructions to install it should reflect that.Which Jira/Github issue(s) does this PR fix?
Special notes for your reviewer
None.
Unit Test Coverage
Guidelines
Test coverage checks
Pre-checks (if applicable)
/label tide/merge-method-squash
Summary by CodeRabbit