Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove mentions of Beaker 3 #165

Merged
merged 1 commit into from
Aug 9, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 8 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,23 @@ of beaker, please do, we would love any help that you'd like to provide.

# How Do I Use This?

## With Beaker 3.x
You will need to include beaker-puppet alongside Beaker in your Gemfile or project.gemspec. E.g.

This library is included as a dependency of Beaker 3.x versions and is automatically included, so there's nothing to do.

## With Beaker 4.x

As of Version 1.0 of `beaker-puppet`, the minimum supported version of beaker is Version 4.0. If you use `ENV['BEAKER_VERSION']`, you will have to ensure that this is compatible, and that if you are using a local Git repository it is up to date.

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
```ruby
# Gemfile
gem 'beaker', '~>4.0'
gem 'beaker-puppet', '~>1.0'
# project.gemspec
s.add_runtime_dependency 'beaker', '~>4.0'
s.add_runtime_dependency 'beaker-puppet', '~>1.0'
~~~

For DSL Extension Libraries, you must also ensure that you `require` the library in your test files. You can do this manually in individual test files or in a test helper (if you have one). You can [use `Bundler.require()`](https://bundler.io/v1.16/guides/groups.html) to require the library automatically.

### Right Now? (beaker 3.x)

At this point, beaker-puppet is included in beaker, so you don't have to _do_
anything to get the methods in this library.

You can use these methods in a test by referencing them by name without
qualifications, as they're included in the beaker DSL by default.

### In beaker's Next Major Version? (beaker 4.x)
```

In beaker's next major version, the requirement for beaker-puppet 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-puppet as a dependency right
next to beaker itself.
For DSL Extension Libraries, you must also ensure that you `require` the
library in your test files. You can do this manually in individual test files
or in a test helper (if you have one). You can [use
`Bundler.require()`](https://bundler.io/v1.16/guides/groups.html) to require
the library automatically. To explicitly require it:

Once you've done that & installed the gems, in your test, you'll have to
```ruby
require 'beaker-puppet'
```
Expand Down