Merge pull request #150 from bastelfreak/rel1210

Release 1.21.0 with proper changelog

.github/workflows/release.yml

@@ -8,6 +8,8 @@ jobs:
   release:
     runs-on: ubuntu-latest
     if: github.repository == 'voxpupuli/beaker-puppet'
+    env:
+      BUNDLE_WITHOUT: release
     steps:
       - uses: actions/checkout@v2
       - name: Install Ruby 2.7

.github/workflows/test.yml

@@ -15,6 +15,8 @@ jobs:
           - "2.5"
           - "2.6"
           - "2.7"
+    env:
+      BUNDLE_WITHOUT: release
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2

Gemfile

@@ -2,7 +2,9 @@ source ENV['GEM_SOURCE'] || "https://rubygems.org"
 
 gemspec
 
-
+group :release do
+  gem 'github_changelog_generator',  :require => false, :git => 'https://github.com/voxpupuli/github-changelog-generator', :branch => 'voxpupuli_essential_fixes'
+end
 
 def location_for(place, fake_version = nil)
   if place =~ /^(git:[^#]*)#(.*)/

README.md

@@ -5,7 +5,7 @@ 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?
 
@@ -80,6 +80,25 @@ Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs
 
 # Releasing
 
-To release the gem, update the version at `lib/beaker-puppet/version` then tag
-the repo with the corresponding version. Once tagged, a Github Action will
-trigger which builds and publishes the gem.
+* Install the required gems to generate the changelog:
+
+```
+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

Rakefile

@@ -297,3 +297,16 @@ namespace :docs do
     end
   end
 end
+
+begin
+  require 'github_changelog_generator/task'
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
+    config.exclude_labels = %w{duplicate question invalid wontfix wont-fix skip-changelog}
+    config.user = 'voxpupuli'
+    config.project = 'beaker-puppet'
+    config.future_release = "v#{Gem::Specification.load("#{config.project}.gemspec").version}"
+  end
+rescue LoadError
+end

lib/beaker-puppet/version.rb

@@ -1,3 +1,3 @@
 module BeakerPuppet
-  VERSION = '1.20.0'
+  VERSION = '1.21.0'
 end