Skip to content

Add Homebrew installation documentation for macOS - #264

Open
paramcodes wants to merge 1 commit into
bholmesdev:mainfrom
paramcodes:feature/homebrew-installation
Open

paramcodes wants to merge 1 commit into
bholmesdev:mainfrom
paramcodes:feature/homebrew-installation

Conversation

@paramcodes

Copy link
Copy Markdown

Summary

  • Adds Homebrew installation instructions to README.md for macOS users
  • Documents the community-maintained Homebrew tap at PARAM-ship/homebrew-hubble
  • Includes installation and update commands
  • Adds changelog entry under [Unreleased]

This addresses issue #174 by providing an easy Homebrew installation method for macOS users who prefer package managers over manual downloads.

Test plan

  • Verified the README.md changes include clear installation instructions
  • Verified the CHANGELOG.md entry follows the project's format
  • Tested the branch locally to ensure no unintended changes
  • The changes are documentation-only, so no functional testing required

Generated with Devin

@vercel

vercel Bot commented Aug 13, 2026

Copy link
Copy Markdown

@paramcodes is attempting to deploy a commit to the bholmesdev's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot left a comment

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.

Overview

Docs-only PR: Homebrew install/update steps in README, plus Unreleased changelog bullet for the community tap PARAM-ship/hubble / cask hubble-md. Tap and cask exist; install commands match the tap README.

Concerns

  • Changelog entry links issue #174 instead of this PR, against the repo changelog skill (always link the PR).
  • Optional: credit PR author @paramcodes (entry thanks @PARAM-ship); note cask is Apple Silicon–only if you want parity with the tap README.

Verdict

Found: 0 critical, 1 important, 2 suggestions

Request changes


Reviewed by a Warp Factory agent.

Comment thread CHANGELOG.md Outdated
Comment thread README.md Outdated
brew upgrade --cask hubble-md
```

The Homebrew tap is maintained by the community and automatically updates when new Hubble.md releases are published.

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.

💡 [SUGGESTION] Tap cask is Apple Silicon (arm64) only (matches current macOS release assets). Say so so Intel users aren’t surprised.

Suggested change
The Homebrew tap is maintained by the community and automatically updates when new Hubble.md releases are published.
The Homebrew tap is maintained by the community and automatically updates when new Hubble.md releases are published. The cask currently installs the Apple Silicon (arm64) build.

Comment thread README.md Outdated

### Homebrew (macOS)

For macOS users, you can also install Hubble via Homebrew:

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.

💡 [SUGGESTION] Slightly tighter lead-in matches nearby README tone.

Suggested change
For macOS users, you can also install Hubble via Homebrew:
Install via Homebrew:

@github-actions github-actions Bot left a comment

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.

Overview

Follow-up on docs-only Homebrew install PR. Delta fixes the prior changelog finding: credits @paramcodes and links #264. Install/update commands and community-tap note still look correct.

Prior review

  • Addressed: changelog links PR (not #174) and thanks PR author.
  • Still open (non-blocking): optional Apple Silicon–only cask note; optional tighter README lead-in. No author reply declining them; leave as product polish.

Concerns

None blocking. No new/regressed issues in the delta.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve


Reviewed by a Warp Factory agent.

@bholmesdev

bholmesdev commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

Merge risk: medium

Impact: medium 👀

  • Docs only, but the official README would recommend a third-party tap (PARAM-ship/homebrew-hubble, created 2026-08) that this repo doesn't control. Future cask changes are outside review.
  • The cask only ships the arm64 DMG with no depends_on arch, so Intel Macs will fail. It lacks auto_updates true, so brew upgrade and the in-app updater can conflict.

Rollback cost: low ✅

  • Reverting the README is trivial. Users who already installed via the tap stay on it.

Error detection: N/A

Verification: poor ⚠️

  • No evidence of an actual brew install or brew upgrade run.

Alignment: decent 👀

  • Addresses brew install hubble.md #174 through a community tap rather than an official cask. Needs a maintainer call.
  • Conflicts with main (CHANGELOG).

Documents the community-maintained Homebrew tap for Hubble.md,
allowing macOS users to install and update via `brew install --cask hubble-md`.

Resolves bholmesdev#174

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@paramcodes
paramcodes force-pushed the feature/homebrew-installation branch from 438f7b3 to c484fbf Compare October 19, 2026 05:20
@paramcodes

Copy link
Copy Markdown
Author

Addressed each item from your review:

  1. Cask DSL updates (PARAM-ship/homebrew-hubble):

    • Added depends_on arch: :arm64 so Intel Macs won't download an incompatible binary.
    • Added auto_updates true to prevent collisions with the in-app updater.
    • Added zap trash: targeting com.benholmes.hubblemd.desktop for clean uninstalls.
    • Cleaned up deprecated verified: parameter.
  2. Verification & Proof:

    • Added an automated macOS CI test workflow to the tap repository running on GitHub Actions macos-latest (Apple Silicon M-series).
    • Passed strict audit and end-to-end installation/uninstall: Run #39204119087.
  3. Rebased & Conflicts Cleared:

    • Rebased onto latest main; PR is clean and mergeable.
    • Clarified the Apple Silicon requirement in README.md.
  4. Regarding Intel Macs & Future releases:

    • Intel Macs are currently restricted because desktop-release.yml uses bare electron-builder --mac, which only packages the host architecture (arm64 on GitHub's macOS runners).
    • If you'd like, I can open a quick follow-up PR changing that to electron-builder --mac --universal so future releases produce a single universal DMG covering all Mac users.
  5. Tap Ownership / Governance:

    • If you'd prefer official maintainer control rather than pointing docs to a third-party tap, I'm happy to transfer PARAM-ship/homebrew-hubble to bholmesdev/homebrew-tap (and help wire release automation into your tag release workflow).
    • Alternatively, we can submit hubble-md directly to official homebrew/cask.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants