cookbook 'homebrew', '= 2.1.0'
Install Homebrew and includes resources for working with taps and casks
cookbook 'homebrew', '= 2.1.0', :supermarket
knife supermarket install homebrew
knife supermarket download homebrew
This cookbook installs Homebrew and under Chef 11 and earlier versions, its package provider replaces MacPorts as the default package provider for the package resource on OS X systems.
Chef 12: The package provider is not necessary on Chef 12, as the default OS X package provider is homebrew.
Chef <= 11: The package provider will be set as the default provider for OS X.
In order for this recipe to work, your userid must own
/usr/local. This is outside the scope of the cookbook because it's possible that you'll run the cookbook as your own user, not root and you'd have to be root to take ownership of the directory. Easiest way to get started:
sudo chown -R `whoami`:staff /usr/local
Bear in mind that this will take ownership of the entire folder and its contents, so if you've already got stuff in there (eg MySQL owned by a
mysql user) you'll need to be a touch more careful. This is a recommendation from the Homebrew project.
Note This cookbook only supports installing in
/usr/local. While the Homebrew project itself allows for alternative installations, this cookbook doesn't.
- Mac OS X (10.6+)
The only platform supported by Homebrew itself at the time of this writing is Mac OS X. It should work fine on Server edition as well, and on platforms that Homebrew supports in the future.
- build-essential: homebrew itself doesn't work well if XCode is not installed.
node['homebrew']['owner']- The user that will own the Homebrew installation and packages. Setting this will override the default behavior which is to use the non-privileged user that has invoked the Chef run (or the
SUDO_USERif invoked with sudo). The default is
node['homebrew']['auto-update']- Whether the default recipe should automatically update homebrew each run or not. The default is
trueto maintain compatibility. Set to false or nil to disable. Note that disabling this feature may cause formula to not work.
node['homebrew']['formulas']- An Array of formula that should be installed using homebrew by default, used only in the
- To install the most recent version, include just the recipe name:
- To install a specific version, specify both its name and version:
- name: special-version-formula version: 1.2.3
- To install the HEAD of a formula, specify both its name and
- name: head-tracking-formula head: true
- To install the most recent version, include just the recipe name:
node['homebrew']['casks']- An Array of casks that should be installed using brew cask by default, used only in the
node['homebrew']['taps']- An Array of taps that should be installed using brew tap by default, used only in the
Resources and Providers
This cookbook includes a package resource provider to use homebrew. Under Chef 12+, this is not necessary, and the code doesn't actually get used on Chef 12+. This was preserved to maintain backwards compatiblity with older versions of Chef.
package / homebrew_package
This cookbook provides a package provider called
homebrew_package which will install/remove packages using Homebrew. This becomes the default provider for
package if your platform is Mac OS X.
As this extends the built-in package resource/provider in Chef, it has all the resource attributes and actions available to the package resource. However, a couple notes:
- Homebrew itself doesn't have a notion of "upgrade" per se. The "upgrade" action will simply perform an install, and if the Homebrew Formula for the package is newer, it will upgrade.
- Likewise, Homebrew doesn't have a purge, but the "purge" action will act like "remove".
package 'mysql' do action :install end homebrew_package 'mysql' package 'mysql' do provider Chef::Provider::Package::Homebrew end package 'wireshark' do options '--with-qt --devel' end
brew tap, a Homebrew command used to add additional formula repositories. From the
brew man page:
tap [tap] Tap a new formula repository from GitHub, or list existing taps. tap is of the form user/repo, e.g. brew tap homebrew/dupes.
Default action is
:tap which enables the repository. Use
:untap to disable a tapped repository.
homebrew_tap 'homebrew/dupes' homebrew_tap 'homebrew/dupes' do action :untap end
brew cask, a Homebrew-style CLI workflow for the administration of Mac applications distributed as binaries. It's implemented as a homebrew "external command" called cask.
You must have the homebrew-cask repository tapped.
And then install the homebrew cask package before using this LWRP.
package "brew-cask" do action :install end
You can include the
homebrew::cask recipe to do this.
homebrew_cask "google-chrome" homebrew_cask "google-chrome" do action :uncask end
Default action is
:cask which installs the Application binary . Use
:uncask to uninstall a an Application.
We strongly recommend that you put "recipe[homebrew]" in your node's run list, to ensure that it is available on the system and that Homebrew itself gets installed. Putting an explicit dependency in the metadata will cause the cookbook to be downloaded and the library loaded, thus resulting in changing the package provider on Mac OS X, so if you have systems you want to use the default (Mac Ports), they would be changed to Homebrew.
The default recipe also ensures that Homebrew is installed and up to date if the auto update attribute (above) is true (default).
License and Authors
This cookbook is maintained by CHEF. The original author, maintainer and copyright holder is Graeme Mathieson. The cookbook remains licensed under the Apache License version 2.
Author:: Graeme Mathieson (email@example.com)
Author:: Joshua Timberman (firstname.lastname@example.org)
Copyright:: 2011, Graeme Mathieson Copyright:: 2012-2015, Chef Software, Inc. <email@example.com> Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
|build-essential >= 2.1.2|
homebrew Cookbook CHANGELOG
This file is used to list changes made in each version of the homebrew cookbook.
- Make homebrew install script url configurable
- Make package_info more efficient
- Updated execute resources to pass in the HOME/USER environmental variables so homebrew commands are properly executed
- Removed redundant code from recipes and providers
- Removed brew-cask installation and the upgade execute that are no longer necessary
- Added directory creation of /Library/Caches/Homebrew/Casks in case it's not present
- Updated creation of /opt/homebrew-cask to be recursive in case /opt hasn't been created yet
- Use the officially supported method of querying homebrew data vs. unsupported internal APIs
- Fixed environmental variables in the homebrew command execution
- Fixed poor name matching in determining if a cask had been installed already, which prevented some casks from installing
- Prevents casks from installing on every chef run
- Fixed already-installed casks breaking builds
- Removed all Chef 10 compatibility code
- 77 Update the tap provider to properly notify on changes
- 73 Allow specifying versions (or HEAD) of formulas (see readme for usage)
- Updated contributing, testing, and maintainers docs
- Updated contents of chefignore and .gitignore files
- Updated development dependencies in the Gemfile
- Added Travis CI and supermarket version badges to the readme
- Added Chef standard rubocop file and resolved all warnings
- Added super metadata for Supermarket
- Added testing in Travis CI
- 75 Fix Chefspecs to properly run on Linux hosts (like Travis)
- Add Rakefile for simplified testing
- Resolved all foodcritic warnings
- 72 Massage Chef12HomebrewUser.find_homebrew_uid into username
- 69 Add options to cask
- 67 Add attribute and recipe for installing homebrew taps
- 59 Update Homebrew Cask if auto-update attribute is true
- 52 Manage Homebrew Cask's install directories
- 56 Fix check for existing casks
- 61 Fix owner class for Chef 12
- Depend on build-essential cookbook 2.1.2+ to support OS X 10.10
- 64, #66 add and fix ChefSpec tests for default recipe
- 55 This cookbook no longer sets its
packageprovider for OS X when running under Chef 12
- List CHEF as the maintainer instead of Chef.
- 57 Update url per homebrew error: Upstream, the homebrew project
- has changed the URL for the installation script. All users of this
- cookbook are advised to update to this version.
- 35 Modernize the cask provider (use why run mode, inline resources)
- 43 Use
brew cask listto determine if casks are installed
- 45 Add
default_actionand print warning messages on earlier
- versions of Chef (10.10)
- 44 Add
:uninstallactions and alias previous
:uncaskactions to them
- 27 Fix name for taps adding the
- 28 Set
nilso Chef can execute in a bundle (bundler
RUBYOPTand this can cause issues when running the
- 40 Fix regex for cask to match current homebrew conventions
- 42 Fix attribute for list of formulas to match the README and
- maintain backward compat for 6 day old version
- Add recipes to install an array of formulas/casks
- Implement attribute to control auto-update
38 - Add homebrew::cask recipe
- [COOK-3283] Use homebrew_owner for cask and tap
- [COOK-4670] homebrew_tap provider is not idempotent
- [COOK-4671] Syntax Error in README
- Fixing cask provider correctly this time. "brew cask list"
- Fixing typo in cask provider: 's/brew brew/brew/'
- [COOK-3960] Added LWRP for brew cask
- [COOK-4508] Add ChefSpec matchers for homebrew_tap
- [COOK-4566] Guard against "HEAD only" formulae
- [COOK-4023] Fix installer script's URL.
- Fixing up style for rubocop
- [COOK-3825] setting $HOME on homebrew_package
- COOK-3589 - Add homebrew as the default package manager on OS X Server
- COOK-3283 - Support running homebrew cookbook as root user, with sudo, or a non-privileged user
- [COOK-1793] - use homebrew "go" script to install homebrew
- [COOK-1821] - Discovered version using Homebrew Formula factory fails check that verifies that version is a String
- [COOK-1843] - Homebrew README.md contains non-ASCII characters, triggering same issue as COOK-522
- [COOK-1425] - use new json output format for formula
- [COOK-1578] - Use shell_out! instead of popen4
Chef Software has taken maintenance of this cookbook as the original author has other commitments. This is the initial release with Chef Software as maintainer.
Changes in this release:
- [pull/2] - support for option passing to brew
- [pull/3] - add brew upgrade and control return value from command
- [pull/9] - added LWRP for "brew tap"
- README is now markdown, not rdoc.
2.1.0 passed this metric
2.1.0 passed this metric