Homebrew Cookbook

This cookbook installs Homebrew and provides resources for working with taps and casks

Requirements

Platforms

• macOS

Chef

• Chef 12.1+

Cookbooks

• none

Attributes

• 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_USER if invoked with sudo). The default is nil.

• node['homebrew']['auto-update'] - Whether the default recipe should automatically update Homebrew each run or not. The default is true to 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 homebrew::install_formulas recipe.

  • To install the most recent version, include just the recipe name: - simple_formula

  • 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 head: true:

    - name: head-tracking-formula
      head: true
    

  • To provide other options, specify both its name and options

    - name: formula-with-options
      options: --with-option-1 --with-other-option
    

• node['homebrew']['casks'] - An Array of casks that should be installed using brew cask by default, used only in the homebrew::install_casks recipe.

• node['homebrew']['taps'] - An Array of taps that should be installed using brew tap by default, used only in the homebrew::install_taps recipe.

Resources (provider)

homebrew_tap

LWRP for 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.

Examples

homebrew_tap 'homebrew/dupes'

homebrew_tap 'homebrew/dupes' do
  action :untap
end

homebrew_cask

LWRP for 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.

homebrew-cask on GitHub

Prerequisites

You must have the homebrew-cask repository tapped.

homebrew_tap 'caskroom/cask'

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.

Examples

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.

View the list of available Casks

Usage

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.

Original blog post by Graeme

Author:: Graeme Mathieson (mathie@woss.name)

Author:: Joshua Timberman (joshua@chef.io)

Copyright:: 2011, Graeme Mathieson
Copyright:: 2012-2016, Chef Software, Inc. <legal@chef.io>

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.