mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #19823 from Homebrew/brewfile_docs_tweaks

Browse Source 
docs/Brew-Bundle-and-Brewfile: a couple of tweaks.
This commit is contained in:
Mike McQuaid 2025-04-25 14:25:38 +00:00 committed by GitHub
commit 83e4d73670
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/Brew-Bundle-and-Brewfile.md
View File

@ -22,7 +22,7 @@ A simple `Brewfile` might contain a formula:
brew "ruby"
```
When you run `brew bundle install` (or: just `brew bundle` for short), this will run `brew install ruby` to install Ruby if needed.
When you run `brew bundle install` (or: just `brew bundle` for short), this will take instructions from the `Brewfile` to run `brew install ruby` and install Ruby if needed.
```console
$ brew bundle
@ -82,12 +82,15 @@ Using editorconfig.editorconfig
### Projects
Adding a `Brewfile` to a project's repository (like you might a `package.json`, `Gemfile` or `requirements.txt`) is a nicer way of encoding project dependencies.
Adding a `Brewfile` to a project's repository (like you might a `package.json`, `Gemfile` or `requirements.txt`) is a nicer way of encoding project dependencies for developer environments.
It allows you to tell users to run a single command to install all dependencies for a project and start any services.
As Homebrew supports both macOS, Linux and WSL: you can have this single command setup project dependencies on three operating systems and in continuous integration services like GitHub Actions (where it's installed by default on macOS and easily on Linux with [`Homebrew/actions/setup-homebrew`](https://github.com/Homebrew/actions/tree/master/setup-homebrew)).
See [GitHub's "Scripts To Rule Them All" `script/bootstrap` example](https://github.com/github/scripts-to-rule-them-all/blob/master/script/bootstrap)
for how you might use a `Brewfile` and `brew bundle` to install project dependencies with Homebrew.
### `brew bundle dump`
`Brewfile`s can also be used as a way of saving all supported packages into a single file.