README.md in beaker-puppet-1.20.0 vs README.md in beaker-puppet-1.21.0

- old
+ new

@@ -3,11 +3,11 @@ 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. +of beaker, please do, we would love any help that you'd like to provide. # How Do I Use This? ## With Beaker 3.x @@ -78,12 +78,27 @@ Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide. # Releasing -To release new versions of beaker-puppet, please use the [jenkins job](https://cinext-jenkinsmaster-sre-prod-1.delivery.puppetlabs.net/job/qe_beaker-puppet_init-multijob_master/). This job -lives on internal infrastructure. +* Install the required gems to generate the changelog: -To run the job, click on `Build with Parameters` in the menu on the left. Make -sure you check the box next to `PUBLIC` and enter the appropriate version. The -version should adhere to semantic version standards. When in doubt, consult the -maintainers of Beaker for guidance. +``` +bundle install --path .vendor/ --jobs=$(nproc) --with release +``` + +* Update the gem version in `lib/beaker-puppet/version.rb` + +* 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