This document describes a few components of the
Homebrew/brew repository that are useful for maintainers to
be aware of, but don’t necessarily need to appear in documentation for most users and contributors.
gh pr checkout NUMBER is a super easy way to check out a PR branch using the GitHub CLI.
When reviewing a PR, use “comment”, “approve”, or “request changes” when submitting based on the following guidelines:
Merging is done using the standard Merge button in the
Homebrew/brew repository to preserve
history and GPG commit signing. The Squash and Merge and Rebase and Merge buttons are disabled.
PRs must meet the following conditions to be merged:
If possible, PRs should also have GPG-signed commits (see the private
ops repository for
instructions on setting this up).
To ensure that non-urgent PRs have the opportunity to be seen and reviewed by any other maintainers who wish to take a look, all PRs require an approval before they can be merged. However, not every PR is reviewed by another maintainer, and some PRs are urgent enough that they need to be merged without an approval by another maintainer.
As a compromise between always needing a review and allowing maintainers to merge PRs they deem ready,
Triage CI job will ensure that PRs cannot be merged until they’ve been open for 24 hours
(only counting hours that occur Monday to Friday). After the triage period has expired, the
CI job will show up as “passed” and @BrewTestBot will approve the PR,
allowing it to be merged. This gives all maintainers a reasonable opportunity to review every PR,
but won’t block any PR for lack of reviews.
If the PR is urgent enough that it is necessary to bypass that 24 hour window, the
should be applied to the PR. When this label is applied, the
Triage CI job will immediately be
successful and @BrewTestBot will approve the PR.
Every PR in
Homebrew/brew runs a series of CI tests to try to prevent bugs from being introduced.
A PR must have passing CI before it can be merged.
There are many checks that run on every PR. The following is a quick list of the various checks and what they represent:
Vendor Gems / vendor-gems: This is skipped except for dependabot PRs. It updates the RBI files to match any new/changed dependencies. See Type Checking With Sorbet for more information about RBI files and typechecking.
Triage / review: This verifies that the PR has been open for long enough. See the “Automatic approvals” section above for more information about automatic approvals.
codecov/project: These show the Codecov report for the PR. See the “
brew testsand Codecov” section below for more info about Codecov.
CI / vendored gems (Linux): This checks whether there was a change to the vendored gems on Linux that needs to be committed to the PR branch.
CI / test default formula (Linux): This runs
brew test-boton Linux to ensure it still works as expected.
CI / syntax: This is run first to check whether the PR passes
brew typecheck. If this job fails the following jobs will not run.
CI / tap syntax (Linux): This runs
brew auditon all official taps (note that although this has Linux in its name, it does check
Homebrew/linuxbrew-coreand all cask repos).
CI / docker: This builds and deploys a new Homebrew Docker image.
CI / test everything (macOS): This runs several checks on macOS including
brew test-bot --only-formulae --test-default-formula,
CI / tests (no-compatibility mode),
CI / tests (generic OS)and
CI / tests (Linux): These run
brew testswith various options on Linux.
Note that this list is non-exhaustive and can change over time.
brew testsand Codecov
A coverage report is generated by Codecov for every PR, and its results are shown as CI jobs.
These reports are publicly viewable on Homebrew/brew’s Codecov page.
Additionally, annotations will appear in the PR’s “Files changed” tab where lines of code have been
added that aren’t being hit by
brew tests. If the Codecov job fails, that’s a sign that some
more tests should be added to test the functionality being added in the PR.
Codecov should be used as a guide to indicate when more tests are probably needed, but it’s unrealistic for every line of code to have a test associated with it, especially when testing would require a slow integration test. For this reason, it’s okay to merge PRs that fail the Codecov check if necessary, but this should be avoided if possible.
Homebrew’s manpages and shell completions are generated automatically by the
brew generate-man-completions command.
Contributors are welcome to run this command and commit the changes in a PR, but they don’t have to. If they don’t,
a follow-up PR to make the necessary changes will be opened automatically by @BrewTestBot
once the original PR is merged. These follow-up PRs can be merged immediately if the changes seem correct.
An update can be requested manually by triggering the workflow from the Update maintainers, manpage and completions section under the “Actions” tab. Click on the “Run workflow” dropdown and then the “Run workflow” button. A PR will be opened shortly if there are any changes.