omnibus 5.6.6 → 5.6.8

data/MAINTAINERS.md

@@ -1,23 +0,0 @@
-# Maintainers
-
-This file lists how the `omnibus` project is maintained.
-
-When making changes to the system, you need two maintainers to provide a :+1: on your pull request. Additionally, you need to not receive a veto from a Lieutenant or the Project Lead.
-
-Check out [How Chef is Maintained](https://github.com/chef/chef-rfc/blob/master/rfc030-maintenance-policy.md#how-the-project-is-maintained) for details on the process, how to become a maintainer, lieutenant, or the project lead.
-
-## Project Lead
-
-- [Seth Chisamore](https://github.com/schisamo)
-
-## Maintainers
-
-- [Daniel DeLeo](https://github.com/danielsdeleo)
-- [Jay Mundrawala](https://github.com/jaym)
-- [Kartik Null Cating-Subramanian](https://github.com/ksubrama)
-- [Lamont Granquist](https://github.com/lamont-granquist)
-- [Scott Hain](https://github.com/scotthain)
-- [Seth Vargo](http://github.com/sethvargo)
-- [Steven Danna](https://github.com/stevendanna)
-- [Thom May](https://github.com/thommay)
-- [Yvonne Lam](http://github.com/yzl)

data/VERSION

@@ -1 +0,0 @@
-5.6.6

data/appveyor.yml

@@ -1,39 +0,0 @@
-version: "{build}"
-
-os: Windows Server 2012 R2
-platform:
-  - x64
-
-environment:
-  matrix:
-    - RUBY_VERSION: 24
-    - RUBY_VERSION: 23
-    - RUBY_VERSION: 22
-
-clone_folder: c:\projects\omnibus
-clone_depth: 1
-skip_tags: true
-branches:
-  only:
-    - master
-
-install:
-  - SET PATH=C:\Ruby%RUBY_VERSION%\bin;C:\Ruby23-x64\DevKit\mingw\bin;%PATH%
-  - echo %PATH%
-  - ruby --version
-  - gem --version
-  - gem install bundler -v 1.10.6 --quiet --no-ri --no-rdoc --force
-  - bundler --version
-  - cp C:\Ruby23-x64\DevKit\mingw\bin\bsdtar.exe C:\Ruby23-x64\DevKit\mingw\bin\tar.exe
-  - appveyor DownloadFile http://curl.haxx.se/ca/cacert.pem -FileName C:\cacert.pem
-  - set SSL_CERT_FILE=C:\cacert.pem
-  - git config --global user.email "clouseau@chef.io"
-  - git config --global user.name "Pink Panther"
-
-build_script:
-  - bundle install
-
-test_script:
-  - bundle exec rake unit
-  - bundle exec rake functional
-  - bundle exec rake acceptance

data/docs/Build Cache.md

@@ -1,100 +0,0 @@
-# The Omnibus Build Cache #
-
-The omnibus project includes a project build caching mechanism that
-reduces the time it takes to rebuild a project when only a few
-components need to be rebuilt.
-
-The cache uses git to snapshot the project tree after each software
-component build. The entire contents of the project's `install_dir`
-is included in the snaphot.
-
-When rebuilding, omnibus walks the linearized component list and
-replays the cache until the first item is encountered that needs to be
-rebuilt. Items are rebuilt if the code changes (different version or
-different git SHA) or if the build instructions change (edit to
-config/software/$COMPONENT).
-
-## Location of Cache Data ##
-
-The default location of the cache (which is just a bare git
-repository) is
-`/var/cache/omnibus/cache/git_cache/$INSTALL_DIR`. You can
-customize the location of the cache in the `omnibus.rb` config file
-using the key `git_cache_dir`. For example:
-
-    git_cache_dir "/opt/omnibus-caches"
-
-## How It Works ##
-
-Omnibus begins by loading all projects (see
-`lib/omnibus.rb#expand_software`). The dependencies of each project
-are loaded using `recursively_load_dependency` to capture the
-transitive dependencies of a given project dependency. The result is
-that each project has a list of components in "install order" such
-that all dependencies come before the things that depend on
-them. Components are de-duplicated on the way in and not added if
-already present (which will occur when two components share a common
-dependency).
-
-The actual build order is determined by `library.rb#build_order` which
-does a small reordering to ensure that components that are explicitly
-listed in the project file come last. Since the first cache miss
-causes the system to rebuild everything further to the right in the
-component list, you want to have your most frequently changed
-components last to minimize rebuild churn.
-
-Lightweight git tags are used as cache keys. After building a
-component, a tag name is computed in `GitCache#tag`. The
-tag name has the format `#{name}-#{version}-#{digest}` where name and
-version map to the component that was just built and digest is a
-SHA256 value. The digest is computed by string-ifying the name/version
-pairs of all components built prior to this component (keeping the
-order of course) and prepending the entire contents of the component's
-`config/software/$NAME.rb` file. Important aspects of the cache key
-scheme:
-
-* A change in the order or in the name/version of component built
-  before the component will invalidate the cache key.
-* A change in the component's software config (build instructions)
-  invalidates the cache. This is done conservatively; the entire file
-  contents are included in the digest computation so even a whitespace
-  change will invalidate the key.
-* A change in the version of the component itself will invalidate the
-  key.
-
-You can inspect the cache keys like this:
-
-    git --git-dir=$CACHE_PATH tag -l
-
-You can manually remove a cache entry using `git tag --delete
-$TAG`.
-
-
-## Build Slaves ##
-
-You can share the cache among build slaves using `git clone/fetch`.
-
-Using git bundles is another option (if you're using Jenkins, the bundle
-can be persisted as an artifact):
-
-  + Backup: `git --git-dir=$CACHE_PATH bundle create $CACHE_BUNDLE --tags`
-  + Restore: `git clone --mirror $CACHE_BUNDLE $CACHE_PATH`
-
-(CACHE_BUNDLE is anywhere you're persisting the bundle to)
-
-
-### Important Caveat ###
-
-Note that Omnibus caches instructions *exactly as they will be executed*
-(e.g. Omnibus caches `make -j 9`, it doesn't cache `make -j #{workers}`).
-
-So, if you intend to share your build cache among slaves, you should ensure
-that their build environments are identical (failing which you'll bust the
-cache with commands that depend on the environment).
-
-
-## Mac OS X Caveats ##
-
-When running a build vm on OS X, note that you will likely run into
-trouble if you attempt to locate your cache on your local
-filesystem if it is not case sensitive.

data/docs/Building on Debian.md

@@ -1,61 +0,0 @@
-Building Omnibus Packages for Debian
-====================================
-This document details the steps and configurables for building DEB packages with Omnibus.
-
-
-Building a .deb
----------------
-### Requirements
-Omnibus assumes the existence of the `fakeroot` and `dpkg-deb` command on the build system. The [omnibus cookbook](https://supermarket.getchef.com/cookbooks/omnibus) automatically handles this installation. If you are not using the Omnibus cookbook, you must install these packages manually or using another tool.
-
-### Configurables
-A number of project configuration values are taken into consideration for building Debian packages. These options are further described in the [`Project` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Project).
-
-These values are interpolated and evaluated using Omnibus' internal DEB templates. For 99% of users, these templates should be satisfactory. If you encounter an instance where Omnibus' ERB templates do not satisfy a use case, please open an issue.
-
-Because of the unlikelihood of their necessity, Omnibus does not generate deb-related assets. If you find yourself in a situation where you need to generate highly-customized DEB assets, run the Omnibus new command with the `--deb-assets` flag:
-
-    $ omnibus new NAME --deb-assets
-
-**If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
-
-With the `--deb-assets` flag, Omnibus will generate the following "stock" resources in `resources/NAME/deb`:
-
-- `conffiles.erb` - the list of configuration files
-- `control.erb` - the Debian spec file
-- `md5sums.erb` - the ERB for generating the list of file checksums
-
-**You should only generate the DEB assets if you cannot set values using attributes!**
-
-### DSL
-You can further customize the behavior of the packager using the `package` DSL command in your project definition:
-
-```ruby
-# project.rb
-name 'hamlet'
-
-package :deb do
-  vendor 'Company <company@example.com>'
-  license 'Apache 2.0'
-  priority 'extra'
-  section 'databases'
-  signing_passphrase 'acbd1234'
-end
-```
-
-Some DSL methods available include:
-
-| DSL Method           | Description                                 |
-| :------------------: | --------------------------------------------|
-| `signing_passphrase` | The passphrase to sign the RPM with         |
-| `vendor`             | The name of the package producer            |
-| `license`            | The default license for the package         |
-| `priority`           | The priority for the package                |
-| `section`            | The section for this package                |
-
-If you are unfamiliar with any of these terms, you should just accept the defaults. For more information on the purpose of any of these configuration options, please see the DEB spec.
-
-For more information, please see the [`Packager::DEB` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Packager/DEB).
-
-### Notes on DEB-signing
-To sign an DEB, you will need a GPG keypair. You can [create your own signing key](http://www.madboa.com/geek/gpg-quickstart/) or [import an existing one](http://irtfweb.ifa.hawaii.edu/~lockhart/gpg/gpg-cs.html). Omnibus will automatically call `gpg` with arguments that assume the real name associated to the GPG key is the same as the name of the project maintainer as specified in your Omnibus config.

data/docs/Building on OSX.md

@@ -1,92 +0,0 @@
-Building Omnibus Packages for Mac OS X
-======================================
-This document details the steps and configurables for building omnibus packages on Mac OS X. Unlike Linux-based systems, the process for building a `.pkg` (and compressing with `.dmg`) may involve the customization of some assets.
-
-
-Building a .pkg
----------------
-In Mac OS X, a `.pkg` is a special file that is read by Installer.app that contains the set of instructions for installing a piece of software on a target system.
-
-### Requirements
-By default, Omnibus does not generate pkg-related assets. To generate the pkg assets, run the Omnibus new command with the `--pkg-assets` flag:
-
-    $ omnibus new NAME --pkg-assets
-
-**If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
-
-With the `--pkg-assets` flag, Omnibus will generate the following "stock" resources in `resources/NAME/pkg`:
-
-- `background.png` - the background image for the installer. We recommend this
-image has a light background color (otherwise, the text will be difficult to
-read).
-- `distribution.xml.erb` - the XML file for use during the `productbuild` command
-- `license.html.erb` - the full HTML document for the license
-- `welcome.html.erb` - the full HTML document for the welcome screen
-
-You should use these stock files and templates as a starting point for building your custom pkg.
-
-### DSL
-By default, Omnibus will try to build a pkg package when executed on a Mac OS X operating system. You can further customize the behavior of the packager using the `package` DSL command in your project definition:
-
-```ruby
-# project.rb
-name 'hamlet'
-
-package :pkg do
-  identifier 'com.getchef.hamlet'
-  signing_identity 'acbd1234'
-end
-```
-
-Some DSL methods available include:
-
-| DSL Method         | Description                                 |
-| :----------------: | --------------------------------------------|
-| `identifier`       | The `com.whatever` id for the package       |
-| `signing_identity` | The key to sign the PKG with                |
-
-For more information, please see the [`Packager::PKG` documentation](http://rubydoc.info/github/opscode/omnibus/Omnibus/Packager/PKG).
-
-
-Building a .dmg
----------------
-In Mac OSX, a `.dmg` is a compressed wrapper around a collection of resources, often including a `.pkg`. The possibilities for creating and customizing a DMG are endless, but Omnibus provides a"basic starter case that will generate a pretty DMG that contains the `.pkg` file it creates.
-
-### Requirements
-By default, Omnibus does not generate dmg-related assets. To generate the dmg assets, run the Omnibus new with the `--dmg-assets` flag:
-
-    $ omnibus new NAME --dmg-assets
-
-**If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
-
-With the `--dmg-assets` flag, Omnibus will generate the following "stock" resources in `resources/NAME/dmg`:
-
-- `background.png` - the background image to use for the DMG. We recommend using
-a high-resolution image that is slightly larger than the final length of your
-window (as determined by the `dmg_window_bounds`)
-- `icon.png` - a 1024x1024 @ 300 icon to use for the DMG. We will automatically
-create an icns and scale to smaller sizes
-
-You should use these stock files and templates as a starting point for building your custom dmg.
-
-### DSL
-By default, Omnibus will **not** try to build a compressed dmg. You can enable this compression using the `compress` DSL command in your project definition:
-
-```ruby
-# project.rb
-name 'hamlet'
-
-compress :dmg do
-  window_bounds '200, 200, 750, 600'
-  pkg_position '10, 10'
-end
-```
-
-Some DSL methods available include:
-
-| DSL Method         | Description                                 |
-| :----------------: | --------------------------------------------|
-| `window_bounds`    | The size and location of the DMG window     |
-| `pkg_position`     | The position of the pkg inside the DMG      |
-
-For more information, please see the [`Compressor::DMG` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Compressor/DMG).

data/docs/Building on RHEL.md

@@ -1,75 +0,0 @@
-Building Omnibus Packages for RHEL
-==================================
-This document details the steps and configurables for building RPM packages with Omnibus.
-
-
-Building a .rpm
----------------
-### Requirements
-Omnibus assumes the existence of the `rpmbuild` command on the build system. The [omnibus cookbook](https://supermarket.getchef.com/cookbooks/omnibus) automatically handles this installation. If you are not using the Omnibus cookbook, you must install the package manually or using another tool.
-
-### Configurables
-The following Project values are taken into consideration when building RPMs:
-
-- `build_version`
-- `config_file`
-- `conflicts`
-- `description`
-- `exclude`
-- `extra_package_files`
-- `iteration`
-- `maintainer`
-- `package_name`
-- `package_user`
-- `package_group`
-- `package_scripts_path`
-- `replaces`
-- `runtime_dependency`
-- `url`
-
-These options are further described in the [`Project` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Project).
-
-These values are interpolated and evaluated using Omnibus' internal RPM templates. For 99% of users, these templates should be satisfactory. If you encounter an instance where Omnibus' RPM templates do not satisfy a use case, please open an issue.
-
-Because of the unlikelihood of their necessity, Omnibus does not generate rpm-related assets. If you find yourself in a situation where you need to generate highly-customized RPM assets, run the Omnibus new command with the `--rpm-assets` flag:
-
-    $ omnibus new NAME --rpm-assets
-
-**If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
-
-With the `--rpm-assets` flag, Omnibus will generate the following "stock" resources in `resources/NAME/rpm`:
-
-- `rpmmacros.erb` - the macros file
-- `signing.erb` - a Ruby script for signing RPMs
-- `spec.erb` - the ERB for generating the spec
-
-**You should only generate the RPM assets if you cannot set values using attributes!**
-
-### DSL
-You can further customize the behavior of the packager using the `package` DSL command in your project definition:
-
-```ruby
-# project.rb
-name 'hamlet'
-
-package :rpm do
-  signing_passphrase 'acbd1234'
-end
-```
-
-Some DSL methods available include:
-
-| DSL Method           | Description                                 |
-| :------------------: | --------------------------------------------|
-| `signing_passphrase` | The passphrase to sign the RPM with         |
-| `vendor`             | The name of the package producer            |
-| `license`            | The default license for the package         |
-| `priority`           | The priority for the package                |
-| `category`           | The category for this package               |
-
-If you are unfamiliar with any of these terms, you should just accept the defaults. For more information on the purpose of any of these configuration options, please see the RPM spec.
-
-For more information, please see the [`Packager::RPM` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Packager/RPM).
-
-### Notes on RPM-signing
-To sign an RPM, you will need a GPG keypair. You can [create your own signing key](http://www.madboa.com/geek/gpg-quickstart/) or [import an existing one](http://irtfweb.ifa.hawaii.edu/~lockhart/gpg/gpg-cs.html). Omnibus automatically generates an `.rpmmacros` config file for `rpmbuild` that assumes that the real name associated to the GPG key is the same as the name of the project maintainer as specified in your Omnibus config. You can override this by creating your own `.rpmmacros` using the steps above.

data/docs/Building on Windows.md

@@ -1,57 +0,0 @@
-Building Omnibus Packages for Windows
-=====================================
-This document details the steps and configurables for building omnibus packages on Windows. Unlike Linux-based systems, the process for building an `.msi` may involve the customization of some assets.
-
-
-Building an .msi
-----------------
-In Windows, an `.msi` is a special executable that contains the set of instructions for installating a piece of software on a target system. Please note, Omnibus does not support the creation of `.exe` files.
-
-### Requirements
-By default, Omnibus does not generate msi-related assets. To generate the msi assets, run the Omnibus new command with the `--msi-assets` flag:
-
-    $ omnibus new NAME --msi-assets
-
-**If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
-
-With the `--msi-assets` flag, Omnibus will generate the following "stock" resources in `resources/NAME/msi`:
-
-- `localization-en-us.wxl.erb` => File that contains the strings that are being used in the MSI user interface
-- `parameters.wxi.erb` => File that contains the dynamic information needed for the MSI e.g. version numbers
-- `assets/LICENSE.rtf` => License text in Rich Text Format that is displayed during MSI installation
-- `assets/*.bmp` => Bitmaps that are displayed during installation
-- `assets/*.ico` => Icons that are used in the system for your application
-
-You should use these stock files and templates as a starting point for building your custom msi.
-
-These files are XML files that are created based on Windows WIX Schema. By default they will package the files under configured `install_dir` and present a UI that lets users to choose an installation location for the packaged files. You can modify these XML files based on the [WIX documentation](http://wixtoolset.org/documentation/manual/v3/xsd/).
-
-### DSL
-By default, Omnibus will try to build an msi package when executed on a Windows operating system. You can further customize the behavior of the packager using the `package` DSL command in your project definition:
-
-```ruby
-# project.rb
-name 'hamlet'
-
-package :msi do
-  upgrade_code '2CD7259C-776D-4DDB-A4C8-6E544E580AA1'
-  parameters {
-    'KeyThing' => 'ValueThing'
-  }
-end
-```
-
-Note that `upgrade_code` is **required** and will raise an exception if not defined! Once set, this value must persist for all future versions of your package. To generate a GUID in Ruby, run the following command:
-
-```bash
-ruby -r securerandom -e "puts SecureRandom.uuid"
-```
-
-Some DSL methods available include:
-
-| DSL Method         | Description                                     |
-| :----------------: | ------------------------------------------------|
-| **`upgrade_code`** | The unique GUID for this package                |
-| `parameters`       | And arbirtary list of key-value pairs to render |
-
-For more information, please see the [`Packager::MSI` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Packager/MSI).