[SREP-4818] docs: add intructions to install with Homebrew

[gvnnn]

What type of PR is this?

• fix (Bug Fix)
• feat (New Feature)
• docs (Documentation)
• test (Test Coverage)
• chore (Clean Up / Maintenance Tasks)
• other (Anything that doesn't fit the above)

What this PR does / Why we need it?

backplane-cli is now available within Homebrew, therefore instructions to install it should reflect that.

Which Jira/Github issue(s) does this PR fix?

• Related Issue SREP-4818

Special notes for your reviewer

None.

Unit Test Coverage

Guidelines

• If it's a new sub-command or new function to an existing sub-command, please cover at least 50% of the code
• If it's a bug fix for an existing sub-command, please cover 70% of the code

Test coverage checks

• Added unit tests
• Created jira card to add unit test
• This PR may not need unit tests

Pre-checks (if applicable)

• Ran unit tests locally
• Validated the changes in a cluster
• Included documentation changes with PR
• Backward compatible

/label tide/merge-method-squash

Summary by CodeRabbit

• Documentation
  • Added macOS installation instructions using Homebrew
  • Reorganized installation method sections for improved clarity

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

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

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• README.md is excluded by !**/*.md

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 463402d8-94d8-45a1-a128-b5709191e840

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

Walkthrough

The PR updates the README.md installation documentation by adding a MacOS Homebrew installation option and restructuring subsection headings from "Option 1/Option 2" naming conventions to descriptive subsection titles.

Changes

Installation Documentation Improvements

Layer / File(s)	Summary
MacOS installation and subsection reorganization README.md	Added a new ### MacOS subsection with Homebrew installation instructions (brew install backplane-cli) under "Installation". Renamed the existing "Download from release" and "Build from source" subsections to use consistent ### heading format instead of numbered options.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 12

✅ Passed checks (12 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: adding Homebrew installation instructions to the README documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names	✅ Passed	All Ginkgo test names are stable and deterministic. No dynamic content (fmt.Sprintf, variables, timestamps, IPs, pod names) found in test titles. Test names use descriptive static strings.
Test Structure And Quality	✅ Passed	The custom check requires reviewing Ginkgo test code quality, but this PR only modifies README.md (documentation). No test files are changed, so the check is not applicable.
Microshift Test Compatibility	✅ Passed	This PR is a documentation-only change (README.md). No new Ginkgo e2e tests (It, Describe, Context, When) were added. The MicroShift Test Compatibility check is not applicable.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	The SNO test compatibility check applies only to OpenShift e2e tests. This PR adds unit/integration tests for a CLI tool, not OpenShift e2e tests. Check is not applicable.
Topology-Aware Scheduling Compatibility	✅ Passed	PR only modifies README.md documentation. No deployment manifests, operator code, or controllers are involved. Topology-aware scheduling check does not apply.
Ote Binary Stdout Contract	✅ Passed	PR is documentation-only (README.md). OTE Binary Stdout Contract check applies to executable code changes. No code modified, so check not applicable.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	The PR is a documentation-only change to README.md adding Homebrew installation instructions. No new Ginkgo e2e tests were added. The custom check only applies when new Ginkgo tests are introduced.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

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

📥 Commits

Reviewing files that changed from the base of the PR and between f742511 and 05169b9.

📒 Files selected for processing (1)

• README.md

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.99%. Comparing base (0f4969f) to head (7158f59).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #939   +/-   ##
=======================================
  Coverage   53.99%   53.99%           
=======================================
  Files          82       82           
  Lines        6323     6323           
=======================================
  Hits         3414     3414           
  Misses       2463     2463           
  Partials      446      446           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[joshbranham]

You need to add some Tap first that has this in it right? Or are we publicly listing this in the upstream homebrew tap?

[gvnnn]

It's part of homebrew-core, no need to add a tap.

[gvnnn]

Note for reviewer: since the tools are meant for internal use I've created a dedicated tap and will submit a removal request to homebrew-core. Until then, even when the tap is "tapped", the installation command will require the full namespace to avoid collisions with homebrew-core. I will update the instructions once again once the formulae have been removed from homebrew-core.

[openshift-ci]

@gvnnn: 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.