Skip to content
Open
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/How-To-Open-a-Homebrew-Pull-Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ To make changes on a new branch and submit it for review, create a GitHub pull r

4. Make your changes. For formulae or casks, use `brew edit` or your favourite text editor, using the guidelines in the [Formula Cookbook](Formula-Cookbook.md) or [Cask Cookbook](Cask-Cookbook.md) for reference.
* If there's a `bottle do` block in the formula, don't remove or change it; we'll update it when we merge your PR.
5. Test your changes by running the following, and ensure they all pass without issue. For changed formulae and casks, make sure you do the `brew audit` step after your changed formula/cask has been installed.
5. For changed formulae and casks, make sure you do the `brew audit` step after your changed formula/cask has been installed.
Comment thread
EoinTrial marked this conversation as resolved.
Outdated

For formulae:

Expand All @@ -122,6 +122,16 @@ To make changes on a new branch and submit it for review, create a GitHub pull r
brew audit --strict --online <CHANGED_FORMULA>
Comment thread
EoinTrial marked this conversation as resolved.
Outdated
```

For new formulae, use `--new` instead (which implies `--strict`, `--online` and additional new-formula eligibility checks):

```sh
HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <NEW_FORMULA>
brew test <NEW_FORMULA>
brew audit --new <NEW_FORMULA>
Comment thread
EoinTrial marked this conversation as resolved.
Outdated
```

You can also run `brew lgtm` to run style, typecheck and tests on your changes in one go.

Comment thread
EoinTrial marked this conversation as resolved.
Outdated
For casks:

```sh
Expand Down
Loading