homebrew (68) Versions 2.1.0 Follow68

Install Homebrew and includes resources for working with taps and casks

Policyfile

Berkshelf

Knife

cookbook 'homebrew', '= 2.1.0', :supermarket

cookbook 'homebrew', '= 2.1.0'

knife supermarket install homebrew

knife supermarket download homebrew

README

Dependencies

Changelog

Quality 100%

Homebrew Cookbook

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.

Requirements

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.

Prerequisites

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.

Platform

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.

Cookbooks

build-essential: homebrew itself doesn't work well if XCode is not installed.

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
```
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 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".

Examples

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

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-2015, 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.

Dependent cookbooks

build-essential >= 2.1.2

Contingent cookbooks

homebrew Cookbook CHANGELOG

This file is used to list changes made in each version of the homebrew cookbook.

v2.1.0 (2016-03-29)

Make homebrew install script url configurable
Make package_info more efficient

v2.0.5 (2016-01-25)

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

v2.0.4 (2016-01-20)

Use the officially supported method of querying homebrew data vs. unsupported internal APIs
Fixed environmental variables in the homebrew command execution

v2.0.3 (2015-12-09)

Fixed poor name matching in determining if a cask had been installed already, which prevented some casks from installing

v2.0.2 (2015-12-04)

Prevents casks from installing on every chef run

v2.0.1 (2015-12-03)

Fixed already-installed casks breaking builds

v2.0.0 (2015-12-01)

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

v1.13.0 (2015-06-23)

72 Massage Chef12HomebrewUser.find_homebrew_uid into username
69 Add options to cask

v1.12.0 (2015-01-29)

67 Add attribute and recipe for installing homebrew taps

v1.11.0 (2015-01-12)

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

v1.10.0 (2014-12-09)

55 This cookbook no longer sets its homebrew_package as the
package provider for OS X when running under Chef 12
List CHEF as the maintainer instead of Chef.

v1.9.2 (2014-10-09)

Bug Fixes:

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.

v1.9.0 (2014-07-29)

Improvements:

35 Modernize the cask provider (use why run mode, inline resources)
43 Use brew cask list to determine if casks are installed
45 Add default_action and print warning messages on earlier
versions of Chef (10.10)

New Features:

44 Add :install and :uninstall actions and alias previous :cask,
:uncask actions to them

Bug Fixes:

27 Fix name for taps adding the /homebrew prefix
28 Set RUBYOPT to nil so Chef can execute in a bundle (bundler
sets RUBYOPT and this can cause issues when running the
underlying brew commands)
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

v1.8.0 (2014-07-23)

Add recipes to install an array of formulas/casks

v1.7.2 (2014-06-26)

Implement attribute to control auto-update

v1.7.0 (2014-06-26)

38 - Add homebrew::cask recipe

v1.6.6 (2014-05-29)

[COOK-3283] Use homebrew_owner for cask and tap
[COOK-4670] homebrew_tap provider is not idempotent
[COOK-4671] Syntax Error in README

v1.6.4 (2014-05-08)

Fixing cask provider correctly this time. "brew cask list"

v1.6.2 (2014-05-08)

Fixing typo in cask provider: 's/brew brew/brew/'

v1.6.0 (2014-04-23)

[COOK-3960] Added LWRP for brew cask
[COOK-4508] Add ChefSpec matchers for homebrew_tap
[COOK-4566] Guard against "HEAD only" formulae

v1.5.4

[COOK-4023] Fix installer script's URL.
Fixing up style for rubocop

v1.5.2

[COOK-3825] setting $HOME on homebrew_package

v1.5.0

Bug

COOK-3589 - Add homebrew as the default package manager on OS X Server

v1.4.0

Bug

COOK-3283 - Support running homebrew cookbook as root user, with sudo, or a non-privileged user

v1.3.2

[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

v1.3.0

[COOK-1425] - use new json output format for formula
[COOK-1578] - Use shell_out! instead of popen4

v1.2.0

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.

Foodcritic Metric

2.1.0 passed this metric

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

Homebrew Cookbook

Requirements

Prerequisites

Platform

Cookbooks

Attributes

Resources and Providers

package / homebrew_package

Examples

homebrew_tap

Examples

homebrew_cask

Prerequisites

Examples

Usage

License and Authors

Dependent cookbooks

Contingent cookbooks

homebrew Cookbook CHANGELOG

v2.1.0 (2016-03-29)

v2.0.5 (2016-01-25)

v2.0.4 (2016-01-20)

v2.0.3 (2015-12-09)

v2.0.2 (2015-12-04)

v2.0.1 (2015-12-03)

v2.0.0 (2015-12-01)

v1.13.0 (2015-06-23)

v1.12.0 (2015-01-29)

v1.11.0 (2015-01-12)

v1.10.0 (2014-12-09)

v1.9.2 (2014-10-09)

v1.9.0 (2014-07-29)

v1.8.0 (2014-07-23)

v1.7.2 (2014-06-26)

v1.7.0 (2014-06-26)

38 - Add homebrew::cask recipe

v1.6.6 (2014-05-29)

v1.6.4 (2014-05-08)

v1.6.2 (2014-05-08)

v1.6.0 (2014-04-23)

v1.5.4

v1.5.2

v1.5.0

Bug

v1.4.0

Bug

v1.3.2

v1.3.0

v1.2.0

Foodcritic Metric 2.1.0 passed this metric

Details

Updated March 29, 2016 Created on January 24, 2011

Supported Platforms

License

Foodcritic Metric

2.1.0 passed this metric