Merge pull request #32 from bastelfreak/rel100

Release 1.0.0; update README; fix GitHub actions

.github/workflows/release.yml

@@ -1,24 +1,31 @@
 name: Release
 
 on:
-  create:
-    ref_type: tag
+  push:
+    tags:
+      - '*'
 
 jobs:
   release:
     runs-on: ubuntu-latest
-    if: github.repository == 'voxpupuli/beaker-module_install_helper'
-    env:
-      BUNDLE_WITHOUT: release
+    if: github.repository_owner == 'voxpupuli'
     steps:
       - uses: actions/checkout@v2
-      - name: Install Ruby 2.7
+      - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.7'
+          ruby-version: '3.0'
+          bundler: 'none'
       - name: Build gem
         run: gem build *.gemspec
-      - name: Publish gem
+      - name: Publish gem to rubygems.org
         run: gem push *.gem
         env:
           GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'
+      - name: Setup GitHub packages access
+        run: |
+          mkdir -p ~/.gem
+          echo ":github: Bearer ${{ secrets.GITHUB_TOKEN }}" >> ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+      - name: Publish gem to GitHub packages
+        run: gem push --key github --host https://rubygems.pkg.github.com/${{ github.repository_owner }} *.gem

.github/workflows/test.yml

@@ -2,22 +2,26 @@ name: Test
 
 on:
   - pull_request
+  - push
+
+env:
+  BUNDLE_WITHOUT: release
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby:
-          - "2.4"
-          - "2.5"
-          - "2.6"
-          - "2.7"
-          - "3.0"
+        include:
+          - ruby: "2.4"
+          - ruby: "2.5"
+          - ruby: "2.6"
+          - ruby: "2.7"
+          - ruby: "3.0"
+            coverage: "yes"
     env:
-      BUNDLE_WITHOUT: release
-    name: Ruby ${{ matrix.ruby }}
+      COVERAGE: ${{ matrix.coverage }}
     steps:
       - uses: actions/checkout@v2
       - name: Install Ruby ${{ matrix.ruby }}
@@ -28,4 +32,4 @@ jobs:
       - name: Run tests
         run: bundle exec rake spec
       - name: Verify gem builds
-        run: bundle exec gem build beaker-module_install_helper.gemspec
+        run: bundle exec gem build *.gemspec

.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /.idea/
+.vendor/

CHANGELOG.md

@@ -1,29 +1,96 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+## [1.0.0](https://github.com/voxpupuli/beaker-module_install_helper/tree/1.0.0) (2021-11-03)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/v0.1.7...1.0.0)
+
+**Closed issues:**
+
+- Master fails to build in Travis [\#25](https://github.com/voxpupuli/beaker-module_install_helper/issues/25)
+
+**Merged pull requests:**
+
+- Add beaker-puppet dependency, update gem versions, fix CI [\#31](https://github.com/voxpupuli/beaker-module_install_helper/pull/31) ([ekohl](https://github.com/ekohl))
+- Add Dependabot & GH Actions for testing & release [\#27](https://github.com/voxpupuli/beaker-module_install_helper/pull/27) ([genebean](https://github.com/genebean))
+- Allow passing in options to install\_module [\#26](https://github.com/voxpupuli/beaker-module_install_helper/pull/26) ([ekohl](https://github.com/ekohl))
+- Don't attempt to modify possibly frozen strings [\#24](https://github.com/voxpupuli/beaker-module_install_helper/pull/24) ([beezly](https://github.com/beezly))
+
+## [v0.1.7](https://github.com/voxpupuli/beaker-module_install_helper/tree/v0.1.7) (2017-12-08)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/v0.1.6...v0.1.7)
+
+**Merged pull requests:**
+
+- Release prep 0.1.7 [\#22](https://github.com/voxpupuli/beaker-module_install_helper/pull/22) ([pmcmaw](https://github.com/pmcmaw))
+- Fix broken beaker dependency [\#21](https://github.com/voxpupuli/beaker-module_install_helper/pull/21) ([cdenneen](https://github.com/cdenneen))
+
+## [v0.1.6](https://github.com/voxpupuli/beaker-module_install_helper/tree/v0.1.6) (2017-12-08)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/0.1.5...v0.1.6)
+
+**Merged pull requests:**
+
+- minor gemspec changes [\#20](https://github.com/voxpupuli/beaker-module_install_helper/pull/20) ([pmcmaw](https://github.com/pmcmaw))
+- Release Prep for 0.1.6 [\#19](https://github.com/voxpupuli/beaker-module_install_helper/pull/19) ([pmcmaw](https://github.com/pmcmaw))
+- \(BKR-1254\) Update for Unix::Host does not allow each [\#17](https://github.com/voxpupuli/beaker-module_install_helper/pull/17) ([cdenneen](https://github.com/cdenneen))
+
+## [0.1.5](https://github.com/voxpupuli/beaker-module_install_helper/tree/0.1.5) (2017-07-26)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/0.1.4...0.1.5)
+
+**Merged pull requests:**
+
+- 0.1.5 fix uninitialized constant Net::HTTP [\#16](https://github.com/voxpupuli/beaker-module_install_helper/pull/16) ([hunner](https://github.com/hunner))
+- Fix bug that causes a NoMethodError: undefined method `each' for nil:NilClass [\#15](https://github.com/voxpupuli/beaker-module_install_helper/pull/15) ([dhollinger](https://github.com/dhollinger))
+- Correct markdown formatting [\#14](https://github.com/voxpupuli/beaker-module_install_helper/pull/14) ([ekohl](https://github.com/ekohl))
+
+## [0.1.4](https://github.com/voxpupuli/beaker-module_install_helper/tree/0.1.4) (2017-02-27)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/0.1.3...0.1.4)
+
+**Merged pull requests:**
+
+- Fix get\_module\_source\_directory when module used with Rototiller [\#12](https://github.com/voxpupuli/beaker-module_install_helper/pull/12) ([wilson208](https://github.com/wilson208))
+
+## [0.1.3](https://github.com/voxpupuli/beaker-module_install_helper/tree/0.1.3) (2017-02-22)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/0.1.2...0.1.3)
+
+**Merged pull requests:**
+
+- Fix beaker forge api not specified error [\#11](https://github.com/voxpupuli/beaker-module_install_helper/pull/11) ([wilson208](https://github.com/wilson208))
+
+## [0.1.2](https://github.com/voxpupuli/beaker-module_install_helper/tree/0.1.2) (2017-02-02)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/0.1.1...0.1.2)
+
+**Merged pull requests:**
+
+- Minor version bump for release 0.1.2 [\#10](https://github.com/voxpupuli/beaker-module_install_helper/pull/10) ([wilson208](https://github.com/wilson208))
+- \[MODULES-4312\] Install modules dependencies from alternative forge instances and install modules not specified in metadata.json [\#9](https://github.com/voxpupuli/beaker-module_install_helper/pull/9) ([wilson208](https://github.com/wilson208))
+
+## [0.1.1](https://github.com/voxpupuli/beaker-module_install_helper/tree/0.1.1) (2017-01-09)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/0.1.0...0.1.1)
+
+**Merged pull requests:**
+
+- Release 0.1.1 containing fixes [\#8](https://github.com/voxpupuli/beaker-module_install_helper/pull/8) ([wilson208](https://github.com/wilson208))
+
+## [0.1.0](https://github.com/voxpupuli/beaker-module_install_helper/tree/0.1.0) (2017-01-04)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/2992a8637097a36d1452be05348f11715a587bc7...0.1.0)
 
-## [0.1.7]
-### Fixed
-- gemspec changes
+**Merged pull requests:**
 
-## [0.1.6]
-### Fixed
-- (BKR-1254) Update for Unix::Host does not allow each
-- Rubocop failures
+- Add maintainers file [\#7](https://github.com/voxpupuli/beaker-module_install_helper/pull/7) ([wilson208](https://github.com/wilson208))
+- Add CONTRIBUTING.md, a README update and version bump before initial release [\#6](https://github.com/voxpupuli/beaker-module_install_helper/pull/6) ([wilson208](https://github.com/wilson208))
+- Implement install\_module\_dependencies\_on method [\#5](https://github.com/voxpupuli/beaker-module_install_helper/pull/5) ([wilson208](https://github.com/wilson208))
+- \[MODULES-4152\] Implement install\_module and install\_module\_on methods [\#3](https://github.com/voxpupuli/beaker-module_install_helper/pull/3) ([wilson208](https://github.com/wilson208))
+- \[MODULES-4157\] Basic setup with stub methods and placeholder tests [\#2](https://github.com/voxpupuli/beaker-module_install_helper/pull/2) ([wilson208](https://github.com/wilson208))
 
-## [0.1.5]
-### Fixed
-- Documentation language updates
-- Rubocop fixes
-- Failure to load Net::HTTP
 
 
-[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/0.1.5...HEAD
-[0.1.6]: https://github.com/olivierlacan/keep-a-changelog/compare/0.1.5...0.1.6
-[0.1.5]: https://github.com/olivierlacan/keep-a-changelog/compare/0.1.4...0.1.5
-[0.1.4]: https://github.com/olivierlacan/keep-a-changelog/compare/0.1.3...0.1.4
-[0.1.3]: https://github.com/olivierlacan/keep-a-changelog/compare/0.1.2...0.1.3
-[0.1.2]: https://github.com/olivierlacan/keep-a-changelog/compare/0.1.1...0.1.2
-[0.1.1]: https://github.com/olivierlacan/keep-a-changelog/compare/0.1.0...0.1.1
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

Gemfile

@@ -15,3 +15,12 @@ group :development do
   gem 'pry'
   gem 'pry-byebug'
 end
+
+group :coverage, optional: ENV['COVERAGE']!='yes' do
+  gem 'simplecov-console', :require => false
+  gem 'codecov', :require => false
+end
+
+group :release do
+  gem 'github_changelog_generator', '>= 1.16.4', require: false if RUBY_VERSION >= '2.5'
+end

README.md

@@ -1,5 +1,12 @@
 ## beaker-module\_install\_helper
 
+[![License](https://img.shields.io/github/license/voxpupuli/beaker-module_install_helper.svg)](https://github.com/voxpupuli/beaker-module_install_helper/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/beaker-module_install_helper/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/beaker-module_install_helper/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/beaker-module_install_helper/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/beaker-module_install_helper/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/beaker-module_install_helper.svg)](https://rubygems.org/gems/beaker-module_install_helper)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/beaker-module_install_helper.svg)](https://rubygems.org/gems/beaker-module_install_helper)
+[![Donated by Puppet Inc](https://img.shields.io/badge/donated%20by-Puppet%20Inc-fb7047.svg)](#transfer-notice)
+
 This gem is simply an abstraction for the various functions that are performed within the `spec/spec_helper_acceptance.rb` files across the modules to standardise how these are implemented.
 
 ### Usage
@@ -55,3 +62,23 @@ BEAKER_FORGE_HOST=https://module-staging.puppetlabs.com BEAKER_FORGE_API=https:/
 
 ### Support
 No support is supplied or implied. Use at your own risk.
+
+## Transfer Notice
+
+This plugin was originally authored by [Puppet Inc](http://puppet.com).
+The maintainer preferred that [Vox Pupuli](https://voxpupuli.org) 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.
+
+## License
+
+This gem is licensed under the Apache-2 license.
+
+## Release information
+
+To make a new release, please do:
+* update the version in the gemspec file
+* 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

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 task default: %i[lint spec]
 
@@ -13,3 +15,18 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = ['--color']
   t.pattern = 'spec'
 end
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+rescue LoadError
+  # github_changelog_generator isn't available, so we won't define a rake task with it
+else
+  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-module_install_helper'
+    config.future_release = Gem::Specification.load("#{config.project}.gemspec").version
+  end
+end

beaker-module_install_helper.gemspec

@@ -3,17 +3,17 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'beaker-module_install_helper'
-  spec.version       = '0.1.7'
-  spec.authors       = ['Puppet']
-  spec.email         = ['wilson@puppet.com']
+  spec.version       = '1.0.0'
+  spec.authors       = ['Vox Pupuli']
+  spec.email         = ['voxpupuli@groups.io']
 
   spec.summary       = 'A helper gem for use in a Puppet Modules ' \
                        'spec_helper_acceptance.rb file'
   spec.description   = 'A helper gem for use in a Puppet Modules ' \
                        'spec_helper_acceptance.rb file to help install the ' \
                        'module under test and its dependencies on the system ' \
                        'under test'
-  spec.homepage      = 'https://github.com/puppetlabs/beaker-module_install_helper'
+  spec.homepage      = 'https://github.com/voxpupuli/beaker-module_install_helper'
   spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files`.split("\n")
@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   # Run time dependencies
   spec.add_runtime_dependency 'beaker', '>= 2.0'
   spec.add_runtime_dependency 'beaker-puppet', '~> 1.0'
+
+  spec.required_ruby_version = '>= 2.4.0'
 end

spec/spec_helper.rb

@@ -1 +1,25 @@
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError
+else
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    enable_coverage :branch
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov,
+  ]
+end
+
 require 'beaker/module_install_helper'