diff options
Diffstat (limited to 'lib/chef/resource/gem_package.rb')
| -rw-r--r-- | lib/chef/resource/gem_package.rb | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/lib/chef/resource/gem_package.rb b/lib/chef/resource/gem_package.rb index a8e16841dc..5cd83d25fd 100644 --- a/lib/chef/resource/gem_package.rb +++ b/lib/chef/resource/gem_package.rb @@ -30,7 +30,7 @@ class Chef # the source can either be a path to a package source like: # source /var/tmp/mygem-1.2.3.4.gem # or it can be a url rubygems source like: - # https://www.rubygems.org + # https://rubygems.org # the default has to be nil in order for the magical wiring up of the name property to # the source pathname to work correctly. # @@ -41,16 +41,16 @@ class Chef property :source, [ String, Array ], description: "Optional. The URL, or list of URLs, at which the gem package is located. This list is added to the source configured in Chef::Config[:rubygems_url] (see also include_default_source) to construct the complete list of rubygems sources. Users in an 'airgapped' environment should set Chef::Config[:rubygems_url] to their local RubyGems mirror." - property :clear_sources, [ TrueClass, FalseClass ], + property :clear_sources, [ TrueClass, FalseClass, nil ], description: "Set to 'true' to download a gem from the path specified by the source property (and not from RubyGems).", default: lazy { Chef::Config[:clear_gem_sources] }, desired_state: false property :gem_binary, String, desired_state: false, - description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by the #{Chef::Dist::CLIENT} will be installed." + description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by the #{Chef::Dist::CLIENT} will be installed." - property :include_default_source, [ TrueClass, FalseClass ], + property :include_default_source, [ TrueClass, FalseClass, nil ], description: "Set to 'false' to not include 'Chef::Config[:rubygems_url]'' in the sources.", - default: true, introduced: "13.0" + default: nil, introduced: "13.0" property :options, [ String, Hash, Array, nil ], description: "Options for the gem install, either a Hash or a String. When a hash is given, the options are passed to Gem::DependencyInstaller.new, and the gem will be installed via the gems API. When a String is given, the gem will be installed by shelling out to the gem command. Using a Hash of options with an explicit gem_binary will result in undefined behavior.", |