kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(PDOC-80) Remove runtime dependency on puppet 

The runtime dependency on puppet presents problems when
puppet is not installed on the system as a gem, as is the
case in PE installations. Because the dependency will only be
satisfied by a gem, strings currently cannot be installed in
PE 3.8. This had to be worked around in newer PE versions with
a fake gemspec file.

Another issue is that installing strings with an older
version of puppet will force an upgrade to the newest version of
puppet via the gem.

This commit replaces the runtime dependency on puppet with a
requirement which will be present on the gem homepage on
rubygems.org. Requirements are meant to list external requirements
needed for the gem to work, which is correct for puppet as it can be
present via a different type of package.
This commit is contained in:
Will Hopper 2016-09-28 10:14:50 -07:00
parent a44ec44708
commit ee4f11968a
2 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -32,6 +32,8 @@ In order to run strings you need to have the following software installed:
* Puppet 3.7 or newer
* The `yard` Ruby gem
Note that a few extra steps are necessary to install puppet-strings with Puppet Enterprise 3.8.
Installing the YARD Gem
-----------------------
@ -47,6 +49,17 @@ For Puppet 3.x:
$ puppet resource package yard provider=gem
```
For Puppet Enterprise 3.8:
```
GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package yard provider=gem
```
Installing the redcarpet Gem (Puppet Enterprise 3.8 only)
-------------------------
```
GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package redcarpet provider=gem
```
Installing Puppet Strings
-------------------------
@ -64,6 +77,11 @@ For Puppet 3.x:
$ puppet resource package puppet-strings provider=gem
```
For Puppet Enterprise 3.8:
```
GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package puppet-strings provider=gem
```
Running Puppet Strings
----------------------

2
puppet-strings.gemspec
View File

@ -17,6 +17,6 @@ Gem::Specification.new do |s|
]
s.files = `git ls-files`.split("\n") - Dir['.*', '*.gemspec']
s.add_runtime_dependency 'puppet', '>= 3.7.0'
s.add_runtime_dependency 'yard', '~> 0.9.5'
s.requirements << 'puppet, >= 3.7.0'
end