README.md in beaker-puppet-1.21.0 vs README.md in beaker-puppet-1.22.0
- old
+ new
@@ -1,53 +1,41 @@
# beaker-puppet: The Puppet-Specific Beaker Library
+[](https://github.com/voxpupuli/beaker-puppet/blob/master/LICENSE)
+[](https://github.com/voxpupuli/beaker-puppet/actions/workflows/test.yml)
+[](https://codecov.io/gh/voxpupuli/beaker-puppet)
+[](https://github.com/voxpupuli/beaker-puppet/actions/workflows/release.yml)
+[](https://rubygems.org/gems/beaker-puppet)
+[](https://rubygems.org/gems/beaker-puppet)
+[](#transfer-notice)
+
The purpose of this library is to hold all puppet-specific info & DSL methods.
This includes all helper & installer methods.
It might not be up to that state yet, but that's the goal for this library. If
you see anything puppet-specific that you'd like to pull into this library out
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.
+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:
-### 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.
-
-Once you've done that & installed the gems, in your test, you'll have to
```ruby
require 'beaker-puppet'
```
Doing this will include (automatically) the beaker-puppet DSL methods in the
@@ -72,33 +60,26 @@
environment, you can use `BEAKER_HOSTS`, passing a file path to a beaker hosts
file, or you can provide a beaker-hostgenerator value to the `TEST_TARGET`
environment variable. You can also specify the tests that get executed with the
`TESTS` environment variable.
-# Contributing
+## Transfer Notice
-Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide.
+This plugin was originally authored by [Puppet Inc](http://puppet.com).
+The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred over, please fork and continue to contribute here.
-# Releasing
+Previously: https://github.com/puppetlabs/beaker
-* Install the required gems to generate the changelog:
+## License
-```
-bundle install --path .vendor/ --jobs=$(nproc) --with release
-```
+This gem is licensed under the Apache-2 license.
-* Update the gem version in `lib/beaker-puppet/version.rb`
+## Release information
-* Export a GitHub access token:
-
-```
-export CHANGELOG_GITHUB_TOKEN=...
-```
-
-* Generate the changelog
-
-```
-bundle exec rake changelog
-```
-
-* Create a PR with the changes
-* After the merge, create a git tag and push it, GitHub Actions will do the release
+To make a new release, please do:
+* update the version in `lib/beaker-puppet/version.rb`
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages