docs(readme): recommend the Homebrew tap as the primary install method#1627
Merged
Conversation
Promote `brew install mergifyio/tap/mergify-cli` to the top of the Installation section as the recommended route, ahead of the install script and manual archive download. Restructure the section into three labelled methods and make the upgrade guidance method-specific: Homebrew installs upgrade with `brew upgrade` (never `mergify self-update`, which clobbers the brew-managed binary), while script installs keep using `mergify self-update`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Change-Id: If23618943da64d2f67f88259b8a688e5def642bd
Contributor
Merge Protections🟢 All 5 merge protections satisfied — ready to merge. |
…inux Scope the Homebrew recommendation to macOS and mark the install script as the recommended route for Linux (it still works on macOS too). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Change-Id: I155321d6d57ab6d16dd412364bd4248643f7862a
There was a problem hiding this comment.
Pull request overview
This PR updates the README installation guidance to recommend installing Mergify CLI via the official Homebrew tap first, and adjusts upgrade instructions to be method-specific (notably avoiding mergify self-update for Homebrew installs).
Changes:
- Promote
brew install mergifyio/tap/mergify-clias the primary (recommended) install path for macOS + Linux. - Clarify that Homebrew installs should be upgraded via
brew upgrade mergify-cli(notmergify self-update). - Reframe the remaining install options into explicit “Install script” and “Manual download” methods.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
A concrete pinned version in the install-script example goes stale and invites copy/paste of an outdated release. Use `<version>` to match the placeholder style of the manual-download section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Change-Id: Ib2e088418d225f479fe1a081045accfb87211e48
sileht
approved these changes
Jun 17, 2026
JulianMaurin
approved these changes
Jun 17, 2026
Contributor
|
Queued — the merge queue status continues in this comment ↓. |
Contributor
Merge Queue Status
This pull request spent 8 minutes 59 seconds in the queue, including 7 minutes 52 seconds running CI. Required conditions to merge
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Promote
brew install mergifyio/tap/mergify-clito the top of the README's Installation section as the recommended route for macOS.What changed
brew install mergifyio/tap/mergify-cli, links to the tap for tap-trust / short-name detailscurl … | shbrew upgrade mergify-cli, notmergify self-update(which overwrites the brew-managed binary). The previous README told every install to usemergify self-update.Windows stays on the manual download since the tap doesn't ship a Windows formula.
🤖 Generated with Claude Code