Skip to content

docs: write the tap README#21

Merged
mergify[bot] merged 4 commits into
mainfrom
devs/kozlek/tap-readme
Jun 16, 2026
Merged

docs: write the tap README#21
mergify[bot] merged 4 commits into
mainfrom
devs/kozlek/tap-readme

Conversation

@kozlek

@kozlek kozlek commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

The tap README was a 5-line stub. This fills it in:

  • Installbrew install mergifyio/tap/mergify-cli (fully-qualified, one step).
  • Homebrew 6.0 tap trust — explains the new model so users aren't surprised: the fully-qualified install trusts just this formula (works as-is), while brew tap + short-name install needs brew trust mergifyio/tap first. Links to the Tap Trust docs.
  • What you get — prebuilt per-arch Rust binaries (macOS/Linux, arm64/x86_64), no compilation.
  • Updatingbrew upgrade, not mergify self-update (mirrors the formula caveat).
  • Maintainers — bump the RELEASE constant + four sha256s, open a PR.

Closes MRGFY-7685.

Test Plan

  • Rendered Markdown reads correctly on GitHub
  • brew test-bot green (docs-only change; no formula edits)

Cover install, the Homebrew 6.0 tap-trust model (the fully-qualified
install trusts just this formula; tap + short-name needs `brew trust`),
what the formula ships (prebuilt per-arch binaries), updating via
`brew upgrade` not `mergify self-update`, and a maintainer bump note.

Closes MRGFY-7685

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: I1534e31aeaa2280b034e80e66f174aeaca9c95d0
Copilot AI review requested due to automatic review settings June 16, 2026 15:18
@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 16, 2026 15:18 Failure
@mergify

mergify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Merge Protections

🟢 All 5 merge protections satisfied — ready to merge.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Expands the repository’s README from a stub into user-facing documentation that explains how to install and update mergify-cli from this Homebrew tap, including guidance around Homebrew’s Tap Trust model.

Changes:

  • Adds detailed install instructions using the fully-qualified formula name and explains Tap Trust implications.
  • Documents what the formula provides (prebuilt per-arch binaries) and how to upgrade safely via Homebrew.
  • Adds maintainer update steps referencing the formula’s RELEASE constant and platform sha256s.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: Ia54569efeffd387a7814fd45c6fa34f55c79a454
@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 16, 2026 15:22 Failure
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: Iafb11ae57da1ff1acaf9e776cc58364a0d91a153
@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 16, 2026 15:22 Failure
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: I426ae0aeb8936d1f0a16ac1b8534de9516285564
@mergify mergify Bot deployed to Mergify Merge Protections June 16, 2026 15:27 Active
@kozlek kozlek requested a review from a team June 16, 2026 15:32
@kozlek kozlek requested a review from a team June 16, 2026 15:50
@mergify

mergify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Queued — the merge queue status continues in this comment ↓.

@mergify

mergify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Merge Queue Status

  • Entered queue2026-06-16 19:06 UTC · Rule: default
  • Checks skipped · PR is already up-to-date
  • Merged2026-06-16 19:08 UTC · at 47b17f106639444ee4fb9f20d14e3b8186f7971f · squash

This pull request spent 2 minutes 11 seconds in the queue, including 5 seconds running CI.

Required conditions to merge

@mergify mergify Bot merged commit 63e08e5 into main Jun 16, 2026
7 checks passed
@mergify mergify Bot added queued and removed queued labels Jun 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants