cookbook 'rvm', '= 1.0.0'
rvm
(29) Versions
1.0.0
-
Follow78
Manages system-wide and per-user RVMs and manages installed Rubies via Chef Resources.
cookbook 'rvm', '= 1.0.0', :supermarket
knife supermarket install rvm
knife supermarket download rvm
RVM
WARNING - Please read!
There is currently a major rewrite going on with this cookbook to simplify
the interface to RVM with Chef. Expect the master branch to be very broken
until there is a 1.0 release. All previous pull requests will need to rebase
to the newer master to contribute to the newly re-factored resources.
<a name="description"></a> Description
Manages system-wide and per-user RVMs and manages installed Rubies.
Several resources are defined to accomplish these tasks.
<a name="requirements"></a> Requirements
<a name="requirements-chef"></a> Chef
Tested on 12.5.1 but older versions of chef may not work due to the changes
in the resource model. You are welcome to submit a pull request to add this
support.
File an issue if this isn't the case.
<a name="requirements-platform"></a> Platform
The following platforms have been tested with this cookbook, meaning that
the recipes and LWRPs run on these platforms without error:
- ubuntu (12.04 and higher)
- debian (6.0 and newer)
- mac_os_x (10.6/10.7) (See Platform Notes)
- mac_os_x_server (See Platform Notes)
- suse (openSUSE, SLES)
- centos
- amazon (2011.09)
- scientific
- redhat
- fedora
- gentoo
Please report any additional platforms so they can be added.
Platform Notes
<a name="platform-notes-osx"></a> OSX
This cookbook suggests the homebrew cookbook, which is needed to install
any additional packages needed to compile ruby. RVM now ships binary rubies,
but will require homebrew to install any additional libraries.
<a name="requirements-cookbooks"></a> Cookbooks
If you are installing JRuby then a Java runtime will need to be
installed. The Opscode java cookbook can be used on supported
platforms.
<a name="installation"></a> Installation
Depending on the situation and use case there are several ways to install
this cookbook. All the methods listed below assume a tagged version release
is the target, but omit the tags to get the head of development. A valid
Chef repository structure like the Opscode repo is also assumed.
<a name="installation-berkshelf"></a> Using Berkshelf
Berkshelf is a way to manage a cookbook or an application's
cookbook dependencies. Include the cookbook in your Berksfile, and then run
berks install
. To install using Berkshelf:
gem install berkshelf cd chef-repo berks init echo "cookbook 'rvm', github: 'fnichol/chef-rvm'" >> Berksfile berks install
<a name="installation-librarian"></a> Using Librarian-Chef
Librarian-Chef is a bundler for your Chef cookbooks.
Include a reference to the cookbook in a Cheffile and run
librarian-chef install
. To install Librarian-Chef:
gem install librarian-chef cd chef-repo librarian-chef init cat >> Cheffile <<END_OF_CHEFFILE cookbook 'rvm', :git => 'git://github.com/fnichol/chef-rvm.git', :ref => 'v0.10.1' END_OF_CHEFFILE librarian-chef install
<a name="recipes"></a> Recipes
<a name="recipes-default"></a> default
Installs the RVM gem and initializes Chef to use the Resources in this cookbook
for installing and managing RVM.
<a name="contributing"></a> Contributing
See the CONTRIBUTING.md file
Testing
Make sure you have the following requirements setup:
After you bundle install
run rake
for unit tests and kitchen test
for
integration level tests.
<a name="license"></a> License and Authors
Authors:: Aaron Kalin (akalin@martinisoftware.com)
Contributors:: https://github.com/sous-chefs/chef-rvm/contributors
Copyright:: 2010 - 2017, Aaron Kalin
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
This cookbook has no specified dependencies.
Contingent cookbooks
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.
1.0.0 (2020-09-16)
- resolved cookstyle error: attributes/default.rb:70:18 refactor:
ChefCorrectness/InvalidPlatformInCase
- resolved cookstyle error: recipes/user_install.rb:29:48 convention:
Layout/TrailingWhitespace
- resolved cookstyle error: recipes/user_install.rb:29:49 refactor:
ChefModernize/FoodcriticComments
- resolved cookstyle error: libraries/provider_rvm_ruby.rb:6:7 refactor:
ChefModernize/RespondToProvides
Breaking Changes
Improvements
- Updated default ruby to 1.9.3-p547 (@martinisoft)
- Added a repository Code of Conduct (See CODE_OF_CONDUCT.md) (@martinisoft)
Documentation
- Pull request #246: Updated README.md documenting use with librarian-chef (@ncreuschling)
- Update URLs to point to sous-chefs GitHub org
- Update the maintainer to be Sous Chefs
Bug Fixes
- Pull request #285: Use GPG for rvm verification. (@lukeasrodgers)
- Pull request #284: Use full class name for rvm_environment resource usage inside Chef::Provider::Package:RVMRubygems class. (@nomadium)
- Pull request #300: Ability to configure key server and home did for rvm gpg_key (@lesniakania)
- Pull request #298: Add GPG check for user installs (@cmluciano)
- Pull request #325: Fix ruby block to align with new style (@cmluciano)
- Remove unnecessary actions method in the rvm_ruby resource
- Remove deprecated
ChefSpec::Coverage.report!
ChefSpec report
0.9.2 (March 31, 2014)
Bug fixes
- Pull request #137: Fix patch attribute support in rvm_ruby. (@mariussturm)
- Pull request #140: Update MRI package requirements for scientific-6 platforms. (@aaronjensen)
- Pull request #134: Fix vagrant_ruby default location on modern vagrant baseboxes. (@mveytsman)
- Pull request #129: Fix broken example in README. (@zacharydanger)
- Pull request #188: Added missing dependencies. (@fmfdias)
- Pull request #151: Add Berkshelf installation instructions. (@justincampbell)
- Pull request #128: Allow for universal rvmrc settings to be used in the user_install. (@firebelly)
- Pull request #204: Minor spelling mistake (@dosire)
- Pull request #183: Only log install when it actually happens (@zsol)
New features
- Pull request #100: Add rubygems_version attribute to rvm_ruby resource. (@cgriego)
- Pull request #125: Omnibus support (via chef_gem). (@gondoi, @cgriego, @jblatt-verticloud, @jschneiderhan)
- Set name attribute in metadata.rb, which may help certain LWRP auto-naming issues when directory name does not match 'rvm' (FC045). (@fnichol)
Improvements
- Refactor foodcritic setup. (@fnichol)
- Now suggests the homebrew cookbook (@martinisoft)
0.9.0 (May 15, 2012)
RVM API tracking updates
- Drop rake 0.9.2 from default global gems to match upstream default. (@fnichol)
- Use RVM stable (stable/head) by default. (@fnichol)
- Pull request #84: Add stable support to installer. (@xdissent)
- Pull request #102: Switch URLs to rvm.io and add "rvm get stable". (@mpapis)
Bug fixes
- Pull request #64: Fix check for rvm in user install. (@dokipen)
- Issue #61: Include Chef::RVM::StringHelpers to provide select_ruby function. (@jheth)
- Pull request #94: Prevent rvm from reinstalling each chef run. (@xdissent)
- Pull request #66: Fixing NoMethodError when using system wide rvm and the gem_package resource. (@kristopher)
- Pull request #95: Fix missing
patch
resource attributes. (@xdissent) - Pull request #96: Fix wrapper paths, now works for both system and user installs. (@xdissent)
- LWRPs now notify when updated (FC017). (@fnichol)
- Node attribute access style (FC019). (@fnichol)
- FC023: Prefer conditional attributes. (@fnichol)
New features
- Update default Ruby to ruby-1.9.3-p194 (it's time). (@fnichol)
- Pull request #86: Add patch attribute to rvm_ruby. (@smdern)
- Pull request #76: Add wrapper for chef-client. (@bryanstearns)
Improvements
- Add TravisCI support for Foodcritic. (@fnichol)
- Large formatting updates to README. (@fnichol)
- Add gh-pages branch for sectioned README at https://fnichol.github.com/chef-rvm. (@fnichol)
- Issue #98: Support installs of x.y.z versions & more permissive upgrade options. (@fnichol)
- Now rvm_global_gem respects version attr in global.gems file. (@fnichol)
- Pull request #88: Mac OS X Server support. (@rhenning)
- Pull request #90: Scientific Linux support. (@TrevorBramble)
0.8.6 (November 28, 2011)
RVM API tracking updates
- Issue #56: Ensure that RVM version strings can be converted to RubyGems format. (@fnichol)
- Issue #53: Update rvm/installer_url default to latest URL. (@fnichol)
Bug fixes
- Issue #54, Pull request #55: Fix if statement typo in
RVM::RubyGems::Package
. (@bradphelan) - Pull request #57: Fix typo in
RVM::RubyGems::Package
. (@bradphelan)
Improvements
- Add note to README warning that chef 0.8.x will not work. (@fnichol)
- Issue #48: Add example of local gem source installation in README. (@fnichol)
0.8.4 (October 16, 2011)
RVM API tracking updates
- Issue #43, Pull request #46: Make explicit use of
exec
for RVM versions older than 1.8.6 anddo
for newer versions. (@ryansch, @fnichol)
Bug fixes
- Pull request #39: Fix rvm_ruby provider on Ubuntu/Debian when installing JRuby. (@exempla)
- Issues #38, #42: Update user_installs attribute to be an array of hashes in README. (@fnichol)
New features
Improvements
- Pull request #44: Add Amazon's Linux AMI support. (@adrianpike)
0.8.2 (August 24, 2011)
Bug fixes
- Ensure Ruby/gemset is installed in rvm_shell provider. (@fnichol)
- Issue #35: Detect if user has RVM installed in rvm_shell provider. (@fnichol)
Improvements
- Array-ize node['rvm']['user_installs']. (@fnichol)
0.8.0 (August 22, 2011)
Bug fixes
- Pull request #22: Expand list of sane rubies to include
"ree"
and"kiji"
. (@juzzin) - Pull request #26: RVM is installed in compilation phase when gem_package recipe is included. (@temujin9, @fnichol)
- Update rvm/vagrant/system_chef_solo default attribute value to match newest Vagrant lucid32 basebox. (@fnichol)
- Pull request #27: Explicitly handle the unmanaged 'system' ruby. (@temujin9).
- Pull request #28: Fix bug when no RVM rubies had yet been installed. (@relistan).
- Pull request #30: Implement 'group_users' support. (@phlipper).
- Update ruby compilation dependencies for debian/ubuntu. (@fnichol)
New features
- Issue #4: Per-user RVM installs with support in all LWRPs. (@fnichol)
- Refactor system and user installs into: system_install, system, user_install, user (reference). (@fnichol)
- Support Mac OS X platform for system-wide and per-user installs. (@fnichol)
- Issue #23: Let gem_package resource target multiple RVM rubies. (@fnichol)
- Pull request #26: Add new attribute
group_id
. (@temujin9) - General refactoring and re-modularizing. (@fnichol)
Improvements
- Pull request #26: RVM unix group is created in compilation phase if GID is provided. (@temujin9)
- Revamp CHANGELOG in the style of guard. (@fnichol)
- Pull request #27: Improve gem_package logging message to include full list of selected rubies. (@temujin9)
- RVM gem installed using opscode cookbook conventions (via gem_package). (@fnichol)
- Add RVM::Shell::ChefWrapper based on chef's popen4 impl. (@fnichol)
- Create RVM::ChefUserEnvironment which can be injected with a user. (@fnichol)
- Normalize 'missing gem' logging notices. (@fnichol)
- Add Chef::RVM::StringCache to get and cache canonical RVM strings. (@fnichol)
- Modularize
libraries/helpers.rb
in modules. (@fnichol) - Issue #25: Add installation options/instructions to README. (@fnichol)
0.7.1 (May 15, 2011)
Bug fixes
New features
- Add Rakefile for opscode platform deploy builds. (@fnichol)
Improvements
- Update metadata.rb properties. (@fnichol)
0.7.0 (May 14, 2011)
Bug fixes
- Issue #20: Update rvm/install_rubies attr to "true"/"false". (@fnichol)
- Issue #14: Allow no default RVM ruby (i.e. use system ruby). (@fnichol)
- Issue #12: Update RVM install to use SSL URL. (@fnichol)
- Now /etc/rvmrc has export for rvm/rvmrc key/value pairs. (@fnichol)
New features
- Issue #13: Speed up install by disabling RDOC generation. (@fnichol)
- New experimental recipe gem_package which patches gem_package resource. (@fnichol)
- Add rvm_global_gem resource. (@fnichol)
Improvements
- Issue #3: Revamp and update README.md. (@fnichol)
- Issue #3: Add CHANGELOG.md. (@fnichol)
- Issue #19: Attr rvm/upgrade accepts "none", false and nil as same value. (@fnichol)
- Update rvm/skip_docs_on_install attr to rvm/rvm_gem_options. (@fnichol)
- Refactor of rvm_gem provider to leverage Chef::Provider::Package::Rubygems. (@fnichol)
Previous releases
The changelog began with version 0.6.0 so any changes prior to that can be
seen by checking the tagged releases and reading git commit messages.
Collaborator Number Metric
1.0.0 passed this metric
Contributing File Metric
1.0.0 passed this metric
Foodcritic Metric
1.0.0 failed this metric
FC022: Resource condition within loop may not behave as expected: rvm/recipes/user_install.rb:29
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.0 passed this metric
Testing File Metric
1.0.0 passed this metric
Version Tag Metric
1.0.0 passed this metric
1.0.0 passed this metric
1.0.0 passed this metric
Foodcritic Metric
1.0.0 failed this metric
FC022: Resource condition within loop may not behave as expected: rvm/recipes/user_install.rb:29
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.0 passed this metric
Testing File Metric
1.0.0 passed this metric
Version Tag Metric
1.0.0 passed this metric
1.0.0 failed this metric
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
1.0.0 passed this metric
Testing File Metric
1.0.0 passed this metric
Version Tag Metric
1.0.0 passed this metric
1.0.0 passed this metric
1.0.0 passed this metric