The build-essential cookbook has been deprecated

Author provided reason for deprecation:

The build-essential cookbook has been deprecated and is no longer being maintained by its authors. Use of the build-essential cookbook is no longer recommended.

RSS

build-essential (52) Versions 8.2.1 Follow278

Installs C compiler / build tools

Policyfile

Berkshelf

Knife

cookbook 'build-essential', '~> 8.2.1', :supermarket

cookbook 'build-essential', '~> 8.2.1'

knife supermarket install build-essential

knife supermarket download build-essential

README

Dependencies

Changelog

Quality 17%

build-essential Cookbook

Installs packages required for compiling C software from source. Use this cookbook if you wish to compile C programs, or install RubyGems with native extensions. Contains a resource, 'build_essential', as as well as a default recipe that simply calls that same resource.

Note: The functionality of this cookbook is now built into Chef 14+ in the build_essential resource. This cookbook is no longer being maintained and all future changes will be done directly in the chef-client. We highly recommend you update your chef-client to the latest release and if possible migrate to using the build_essential resources instead of the recipe in this cookbook.

Requirements

Platforms

Debian/Ubuntu
RHEL/CentOS/Scientific/Amazon/Oracle
openSUSE / SUSE Enterprise Linux
SmartOS
Fedora
Mac OS X 10.9+
FreeBSD

Chef

Chef 12.7+

Cookbooks

seven_zip
mingw

Note for Debian platform family: On Debian platform-family systems, it is recommended that apt-get update be run, to ensure that the package cache is updated. It's not in the scope of this cookbook to do that, as it can create a duplicate resource. We recommend using the apt cookbook to do this.

Attributes

Attribute	Default	Description
`node['build-essential']['compile_time']`	`false`	Execute resources at compile time
`node['build-essential']['msys2']['path']`	`#{ENV['SYSTEMDRIVE']\\msys2`	Destination for msys2 build tool chain (Windows only)

Usage

Recipe Usage

The recipe simply calls the build_essential resource, but it ideal for adding to roles or node run lists.

Include the build-essential recipe in your run list:

knife node run_list add NODE "recipe[build-essential::default]"

or add the build-essential recipe as a dependency and include it from inside another cookbook:

include_recipe 'build-essential::default'

Gems with C extensions

For RubyGems that include native C extensions you wish to use with Chef, you should do the following.

Set the compile_time attribute to true in your wrapper cookbook or role:

   # Wrapper attribute
   default['build-essential']['compile_time'] = true

   # Role
   default_attributes(
     'build-essential' => {
       'compile_time' => true
     }
   )

Ensure that the C libraries, which include files and other assorted "dev"

type packages, are installed in the compile phase after the build-essential

recipe is executed. For example:

   include_recipe 'build-essential::default'

   package('mypackage-devel') { action :nothing }.run_action(:install)

Use the chef_gem resource in your recipe to install the gem with the native

extension:

   chef_gem 'gem-with-native-extension'

Resource Usage

The cookbook includes a resource 'build_essential' that can be included in your cookbook to install the necessary build-essential packages

Simple package installation during the client run:

build_essential 'some name you choose'

Package installation during the compile phase:

build_essential 'some name you choose' do
  compile_time false
end

Maintainers

This cookbook is maintained by Chef's Community Cookbook Engineering team. Our goal is to improve cookbook quality and to aid the community in contributing to cookbooks. To learn more about our team, process, and design goals see our team documentation. To learn more about contributing to cookbooks like this see our contributing documentation, or if you have general questions about this cookbook come chat with us in #cookbok-engineering on the Chef Community Slack

License

Copyright: 2009-2016, Chef Software, Inc.

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

seven_zip >= 0.0.0

mingw >= 1.1

Contingent cookbooks

build-essential Cookbook CHANGELOG

This file is used to list changes made in each version of the build-essential cookbook.

8.2.1 (2018-09-04)

Add a note that this cookbook is no longer maintained as the build_essential resource was moved directly into the chef-client making this cookbook no longer necessary.

8.2.0 (2018-08-28)

Simplify the if installed logic for macos
Remove support for FreeBSD < 10 which is VERY much EOL
Avoid ChefSpec deprecation warnings
Avoid deprecation warnings in Chef 14.3+ by not loading resources already in Chef

8.1.1 (2018-03-17)

Make sure we install the last available xcode command line tool package so we get the latest version

8.1.0 (2018-03-17)

Support Amazon Linux 2.0
Remove the ChefSpec matchers which are autogenerated now in recent ChefDK releaeses. If your specs fail because of this you need to update to a more recent ChefDK release.
Swap Debian 7 testing for Amazon 2 & Ubuntu 18.04 testing since Debian 7 is EOL in May

8.0.4 (2017-11-29)

Install gcc-c and gcc-c++ for solaris 11
Fix dokken's amazonlinux configuration
Update chef dependency in metadata.rb to Chef 12.7
Clean up testing

8.0.3 (2017-05-30)

Fix solaris metadata in metadata.rb
Remove mac_os_x_server from metata as it's not a platform

8.0.2 (2017-05-06)

Remove buggy action_class.class_eval usage

8.0.1 (2017-04-14)

Test with local delivery and not Rake
Ensure compatibility with Chef 12.5
Update apache2 license string
Ensure compatibility with Amazon Linux on Chef 13

8.0.0 (2017-02-14)

Require 12.5 or later and remove compat_resource cookbook dependency

7.0.3 (2016-12-22)

Require the latest compat_resource
Cookstyle fixes

7.0.2 (2016-11-07)

Fix softwareupdate issue from -v to --verbose

7.0.1 (2016-10-06)

Install gcc 4.8 on SUSE < 12

7.0.0 (2016-09-30)

Remove support for OS X < 10.9 and add support for OS X 10.12
Refactor the xcode installer resource as a custom resource that does not require updates for each new OS X update
Use a test recipe with apt_update to avoid needing apt

6.0.6 (2016-09-19)

Remove chef 11 compatibility in the metadata
Solaris 11 needs both make and gnu make

6.0.5 (2016-09-07)

Testing updates
Require the latest compat_resource

6.0.4 (2016-08-19)

Install CLTools from dmg with -allowUntrusted on old OSX
Switch to cookstyle for ruby linting
Add OS X hosts to the kitchen config
Remove chefdk included gems from the Gemfile
Better handle kitchen failures in the Rakefile
Perform all unit/linting in a single travis job

v6.0.3 (2016-07-26)

Fix how gcc version specified for Solaris 11

v6.0.2 (2016-07-22)

Properly warn on Solaris 10
Specify the verson of gcc to install on Solaris 11

v6.0.1 (2016-07-19)

Clarify that this cookbook actually required Chef 12.1 or later not 12.0 or later
Add chef_version metadata

v6.0.0 (2016-06-03)

This cookbook now uses the new msys2 based compiler toolchain on windows. Both 32-bit DW2 and 64-bit SEH based toolchains are available based on the gcc 5.3x series compiler. By default these are located in C:\msys2\mingw32 and C:\msys2\mingw64

v5.0.0 (2016-06-03)

The cookbook now ships with a 12.5+ style custom resource 'build_essential' which performs the same work that the existing default.rb recipe. The default.rb recipe has been converted to consume that resource to provide backwards compatibility for users that use build-essential::default in their run lists or cookbooks. In converting to this custom resource support for EOL omnios has been removed and warning messages for Solaris 10 users have been removed. See the readme for usage information on the new resource.

v4.0.0 (2016-05-12)

Breaking change

This cookbook now requires Chef 12 or later as it includes the new mingw cookbook for installing Windows compilers. Mingw includes 12.5 style custom resources, which will fail to compile on Chef 11. If you are not running Chef 12 you'll need to pin to 3.x in your environment.

v3.2.0 (2016-03-25)

This version backs out a change in the 3.0 release which attempted to install the version of kernel-devel for the current running kernel on RHEL systems. This change had several unintended consequences and we believe the best solution is to back to change out until a better solution for the original problem is developed. Several of the issues could be resolved by code updates to build-essential, but not all, which complicates rolling forward vs. a roll back. The change caused issues which Chefspec runs on cookbooks where build-essential is a dependency as Fauxhai, used by Chefspec, does not mock out node['virtualization']. Fauxhai is being updated to mock out node['virtualization'], but we'd like to make sure a ChefDK release ships with this new Fauxhai before depending on that change.

v3.1.0 (2016-03-23)

Install GCC 4.8 if running on OmniOS >= 151008

v3.0.0 (2016-03-23)

Install GCC 4.9 on FreeBSD < 10
Install the version of kernel-devel that matches the running Kernel on RHEL
Remove suggests 'pkgutil' from the metadata as suggests does nothing
Properly warn the user that build-essential does not support Solaris 10 instead of just silently continuing on
Updated specs to run against more recent OS releases
Removed the warning for OmniOS users from the Readme as the upstream issue has been resolved
Switch from 7-zip to seven_zip cookbook as 7-zip has been deprecated
Add 7-zip to the system path on Windows hosts so the recipe will work out of the box
Switch from the deprecated 7-zip cookbook to seven_zip

v2.4.0 (2016-03-21)

Add gettext package to RHEL / FreeBSD to match other platforms
Fix OS X version detection logic to properly detect OS X 10.10 and 10.11

v2.3.1 (2016-02-18)

Restore Chef 11 compatibility and add Travis / Test Kitchen testing for Chef 11

v2.3.0 (2016-02-17)

Add mingw/msys based build tools for Windows

v2.2.4 (2015-10-06)

Add patch package on Fedora systems
Add additional platforms to Kitchen CI
Use Chef standard Rubocop file and resolve several issues
Update contributing and testing docs
Update Gemfile with the latest testing and development deps
Add maintainers.md and maintainers.toml files
Add chefignore file to limit the files uploaded to the Chef server
Add source_url and issues_url metadata for Supermarket

v2.2.3 (2015-04-15)

Don't install omnibus-build-essential on Solaris 10 - We decided it's easier to use the old GCC that ships with Solaris 10.
Use ChefDK for all Travis testing.

v2.2.2 (2015-03-27)

Update Solar 10's omnibus-build-essential to 0.0.5

v2.2.1 (2015-03-23)

Install GNU Patch on Solaris 11

v2.2.0 (2015-03-18)

[solaris] Differentiate between Solaris 10 and 11
[solaris] Add ucb compat package
[solaris] Solaris 10 build essential setup
Fix metadata to use a string instead of a bool (see #56, #57)

v2.1.3 (2014-11-18)

Update metadata for supported versions of OS X (10.7+) as noted from
v2.0.0 previously (#38)
Clarify requirement to have apt package cache updated in README. (#41)
Fix Xcode CLI installation on OS X (#50)

v2.1.2 (2014-10-14)

Mac OS X 10.10 Yosemite support

v2.1.0 (2014-10-14)

Use fully-qualified names when installing FreeBSD package

v2.0.6 (2014-08-11)

Use the resource form of remote_file to prevent context issues

v2.0.4 (2014-06-06)

[COOK-4661] added patch package to _rhel recipe

v2.0.2 (2014-05-02)

Updated documentation about older Chef versions
Added new SVG badges to the README
Fix a bug where potentially_at_compile_time fails on non-resources

v2.0.0 (2014-03-13)

Updated tested harnesses to use latest ecosystem tools
Added support for FreeBSD
Added support for installing XCode Command Line Tools on OSX (10.7, 10.8, 10.9)
Created a DSL method for wrapping compile_time vs runtime execution
Install additional developement tools on some platforms
Add nicer log and warning messages with helpful information

Potentially Breaking Changes

Dropped support for OSX 10.6
OSX no longer downloads OSX GCC and uses XCode CLI tools instead
build_essential -> build-essential in node attributes
compiletime -> compile_time in node attributes
Cookbook version 2.x no longer supports Chef 10.x

v1.4.4 (2014-02-27)

[COOK-4245] Wrong package name used for developer tools on OS X 10.9

v1.4.2

Bug

COOK-3318 - Use Mixlib::ShellOut instead of Chef::ShellOut

New Feature

COOK-3093 - Add OmniOS support

Improvement

COOK-3024 - Use newer package on SmartOS

v1.4.0

This version splits up the default recipe into recipes included based on the node's platform_family.

[COOK-2505] - backport omnibus builder improvements

v1.3.4

[COOK-2272] - Complete platform_family conversion in build-essential

v1.3.2

[COOK-2069] - build-essential will install osx-gcc-installer when XCode is present

v1.3.0

[COOK-1895] - support smartos

v1.2.0

Add test-kitchen support (source repo only)
[COOK-1677] - build-essential cookbook support for OpenSuse and SLES
[COOK-1718] - build-essential cookbook metadata should include scientific
[COOK-1768] - The apt-get update in build-essentials needs to be renamed

v1.1.2

[COOK-1620] - support OS X 10.8

v1.1.0

[COOK-1098] - support amazon linux
[COOK-1149] - support Mac OS X
[COOK-1296] - allow for compile-time installation of packages through an attribute (see README)

v1.0.2

[COOK-1098] - Add Amazon Linux platform support
[COOK-1149] - Add OS X platform support

Collaborator Number Metric

8.2.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

8.2.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric

8.2.1 failed this metric

Chef/Deprecations/ResourceUsesOnlyResourceName: Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourceusesonlyresourcename): build-essential/resources/xcode_command_line_tools.rb: 20
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): build-essential/resources/build_essential.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): build-essential/resources/xcode_command_line_tools.rb: 1
Chef/Modernize/FoodcriticComments: Remove legacy code comments that disable Foodcritic rules (https://docs.chef.io/workstation/cookstyle/chef_modernize_foodcriticcomments): build-essential/resources/build_essential.rb: 66

Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations

No Binaries Metric

8.2.1 passed this metric

Testing File Metric

8.2.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

8.2.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

The build-essential cookbook has been deprecated

build-essential Cookbook

Requirements

Platforms

Chef

Cookbooks

Attributes

Usage

Recipe Usage

Gems with C extensions

Resource Usage

Maintainers

License

Dependent cookbooks

Contingent cookbooks

build-essential Cookbook CHANGELOG

8.2.1 (2018-09-04)

8.2.0 (2018-08-28)

8.1.1 (2018-03-17)

8.1.0 (2018-03-17)

8.0.4 (2017-11-29)

8.0.3 (2017-05-30)

8.0.2 (2017-05-06)

8.0.1 (2017-04-14)

8.0.0 (2017-02-14)

7.0.3 (2016-12-22)

7.0.2 (2016-11-07)

7.0.1 (2016-10-06)

7.0.0 (2016-09-30)

6.0.6 (2016-09-19)

6.0.5 (2016-09-07)

6.0.4 (2016-08-19)

v6.0.3 (2016-07-26)

v6.0.2 (2016-07-22)

v6.0.1 (2016-07-19)

v6.0.0 (2016-06-03)

v5.0.0 (2016-06-03)

v4.0.0 (2016-05-12)

Breaking change

v3.2.0 (2016-03-25)

v3.1.0 (2016-03-23)

v3.0.0 (2016-03-23)

v2.4.0 (2016-03-21)

v2.3.1 (2016-02-18)

v2.3.0 (2016-02-17)

v2.2.4 (2015-10-06)

v2.2.3 (2015-04-15)

v2.2.2 (2015-03-27)

v2.2.1 (2015-03-23)

v2.2.0 (2015-03-18)

v2.1.3 (2014-11-18)

v2.1.2 (2014-10-14)

v2.1.0 (2014-10-14)

v2.0.6 (2014-08-11)

v2.0.4 (2014-06-06)

v2.0.2 (2014-05-02)

v2.0.0 (2014-03-13)

v1.4.4 (2014-02-27)

v1.4.2

Bug

New Feature

Improvement

v1.4.0

v1.3.4

v1.3.2

v1.3.0

v1.2.0

v1.1.2

v1.1.0

v1.0.2

Collaborator Number Metric 8.2.1 failed this metric Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric 8.2.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

No Binaries Metric 8.2.1 passed this metric

Testing File Metric 8.2.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Collaborator Number Metric

8.2.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

8.2.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

No Binaries Metric

8.2.1 passed this metric

Testing File Metric

8.2.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

8.2.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number