Skip to content

Update the instructions to install from the Homebrew SRE tap#927

Open
gvnnn wants to merge 1 commit into
openshift:masterfrom
gvnnn:update-readme
Open

Update the instructions to install from the Homebrew SRE tap#927
gvnnn wants to merge 1 commit into
openshift:masterfrom
gvnnn:update-readme

Conversation

@gvnnn

@gvnnn gvnnn commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

As the tool is meant for internal use, I've migrated it to a dedicated SRE tap. Until the formula is removed from homebrew-core (I will submit a request), in order to avoid collisions, the install command requires the full namespace regardless of whether the tap is "tapped". I will update the instructions again once the formula is no longer in homebrew-core.

Summary by CodeRabbit

  • Documentation
    • Updated the macOS installation steps to use the recommended Homebrew tap and install path for osdctl.
    • Clarified the setup instructions so users can install the tool from the correct repository source.

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 4382b1f0-349d-45e4-8837-e440bc9658d3

📥 Commits

Reviewing files that changed from the base of the PR and between 1cc60dd and bce3851.

📒 Files selected for processing (1)
  • README.md

Walkthrough

The README’s macOS installation instructions now tell users to tap openshift-online/sre-tools before installing osdctl from that tap.

Changes

README install instructions

Layer / File(s) Summary
Homebrew tap install
README.md
The macOS install section replaces the direct Homebrew install command with a tap step followed by an install from openshift-online/sre-tools/osdctl.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the README change to install via the Homebrew SRE tap.
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 PR only changes README installation text; no Ginkgo tests or test titles were added or edited, so the stable test-name rule isn’t implicated.
Test Structure And Quality ✅ Passed PR only updates README Homebrew install instructions; no Ginkgo test code or test behavior changed, so the test-quality check is not applicable.
Microshift Test Compatibility ✅ Passed Only README.md changed; no Ginkgo e2e tests or API-using test code was added, so MicroShift compatibility is not impacted.
Single Node Openshift (Sno) Test Compatibility ✅ Passed Only README.md was changed to update Homebrew install docs; no Ginkgo/e2e tests were added or modified, so SNO compatibility review is not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed PASS: The PR only updates README installation instructions; no deployment manifests, operator code, or controllers were modified.
Ote Binary Stdout Contract ✅ Passed README-only change; no process-level code was modified, so no new stdout writes were introduced.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed PASS: The PR only updates README macOS install instructions; no new Ginkgo e2e tests or network-facing code were added.
No-Weak-Crypto ✅ Passed Patch only changes README Homebrew install lines; repo search found no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB, custom crypto, or secret compare code in changes.
Container-Privileges ✅ Passed README-only PR; no container/K8s manifest changes or privilege flags were found in the repo.
No-Sensitive-Data-In-Logs ✅ Passed PASS: The PR only updates README install commands to use the SRE tap; no logging code or sensitive fields were added.

✏️ 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

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

@openshift-ci openshift-ci Bot requested review from RaphaelBut and sam-nguyen7 June 25, 2026 10:37
@openshift-ci

openshift-ci Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gvnnn

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:

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

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 25, 2026
@openshift-ci

openshift-ci Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

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

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant