diff --git a/README.md b/README.md index ca7fd23..660a42e 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,27 @@ Beaker library to use google hypervisor # How to use this wizardry -This is a gem that allows you to use hosts with [google compute](google_compute_engine.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). +This is a gem that allows you to use hosts with [google compute](google_compute_engine.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). -### Right Now? (beaker 3.x) +Beaker will automatically load the appropriate hypervisors for any given hosts file, so as long as your project dependencies are satisfied there's nothing else to do. No need to `require` this library in your tests. -This gem is already included as [beaker dependency](https://github.com/puppetlabs/beaker/blob/master/beaker.gemspec) for you, so you don't need to do anything special to use this gem's functionality with beaker. +## With Beaker 3.x -### In beaker's Next Major Version? (beaker 4.x) +This library is included as a dependency of Beaker 3.x versions, so there's nothing to do. + +## With Beaker 4.x + +As of Beaker 4.0, all hypervisor and DSL extension libraries have been removed and are no longer dependencies. In order to use a specific hypervisor or DSL extension library in your project, you will need to include them alongside Beaker in your Gemfile or project.gemspec. E.g. + +~~~ruby +# Gemfile +gem 'beaker', '~>4.0' +gem 'beaker-aws' +# project.gemspec +s.add_runtime_dependency 'beaker', '~>4.0' +s.add_runtime_dependency 'beaker-aws' +~~~ -In beaker's next major version, the requirement for beaker-google will be pulled -from that repo. When that happens, then the usage pattern will change. In order -to use this then, you'll need to include beaker-google as a dependency right -next to beaker itself. # Contributing diff --git a/beaker-google.gemspec b/beaker-google.gemspec index babe176..94c0286 100644 --- a/beaker-google.gemspec +++ b/beaker-google.gemspec @@ -20,7 +20,12 @@ Gem::Specification.new do |s| # Testing dependencies s.add_development_dependency 'rspec', '~> 3.0' s.add_development_dependency 'rspec-its' - s.add_development_dependency 'fakefs', '~> 0.6' + # pin fakefs for Ruby < 2.3 + if RUBY_VERSION < "2.3" + s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14' + else + s.add_development_dependency 'fakefs', '~> 0.6' + end s.add_development_dependency 'rake', '~> 10.1' s.add_development_dependency 'simplecov' s.add_development_dependency 'pry', '~> 0.10'