voxpupuli-release 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356e4d7747c6128502901299af1fba19e71ea8b81b614d3a78a13b1c3d95be03
-  data.tar.gz: 15cf2e0e733939bc3e296647d8f12563dbbc8eefa674cf3f7cca804e2d69a02a
+  metadata.gz: a7173d35800706490167b9fffd1fa15ef2a65186efc861dba5ee266fa0e42450
+  data.tar.gz: ce5576b8d8f1f5dbeaa244629762343e4682093ee99227e1ff20954bf547a4ef
 SHA512:
-  metadata.gz: b216fc76ab233fcc2ee7cdb3cfc37305bf8261485df34b50c09d00035ed336992f3ca038f43a5cee2233717b520b27eb04e87d03b7ff3a01e4465670c3571d98
-  data.tar.gz: 221799d7e7a52e39c9d16fc65087358f49fd140c9635d5a769bf0af6dae9711e967593cd6f2fc4965760eca086121543964cddafd1a367c5e39221123f99a4b4
+  metadata.gz: 52c2c1a80a64d33c78a82f38b2cea87f7625c6801c54cb605a98c86522a91a6376a5273d2833e7c0d15a8ee66715eff08077ae1c1683ab9fb011568d6b579919
+  data.tar.gz: 51ebde857fd8fe104ddc1c2f05beea25f1c86051868f3898aa1ea1490df733b9e59649c8ab3725a737c0a75aa80b7986a25a3d32017ff803d4c06ba5e155b951

data/.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
         env:
           BUNDLE_WITHOUT: release
       - name: Build gem
-        run: gem build *.gemspec
+        run: gem build --strict --verbose *.gemspec
       - name: Publish gem to rubygems.org
         run: gem push *.gem
         env:

data/.github/workflows/test.yml

@@ -8,14 +8,23 @@ env:
   BUNDLE_WITHOUT: release
 
 jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2"
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rake rubocop
   test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         ruby:
-          - "2.5"
-          - "2.6"
           - "2.7"
           - "3.0"
           - "3.1"
@@ -31,4 +40,13 @@ jobs:
       - name: Run tests
         run: bundle exec rake --rakefile Rakefile_ci -T | grep release
       - name: Verify gem builds
-        run: gem build *.gemspec
+        run: gem build --strict --verbose *.gemspec
+
+  tests:
+    needs:
+      - rubocop
+      - test
+    runs-on: ubuntu-latest
+    name: Test suite
+    steps:
+      - run: echo Test suite completed

data/.rubocop.yml

@@ -0,0 +1,5 @@
+---
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  voxpupuli-rubocop: rubocop.yml

data/.rubocop_todo.yml

@@ -0,0 +1,70 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-05-09 13:16:12 UTC using RuboCop version 1.50.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Performance/StringInclude:
+  Exclude:
+    - 'lib/voxpupuli/release/rake_tasks.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/voxpupuli/release/rake_tasks.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowComments.
+# SupportedStyles: empty, nil, both
+Style/EmptyElse:
+  Exclude:
+    - 'lib/voxpupuli/release/rake_tasks.rb'
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'lib/voxpupuli/release.rb'
+    - 'lib/voxpupuli/release/rake_tasks.rb'
+    - 'lib/voxpupuli/release/version.rb'
+    - 'voxpupuli-release.gemspec'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/LineEndConcatenation:
+  Exclude:
+    - 'lib/voxpupuli/release/rake_tasks.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/voxpupuli/release/version.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/voxpupuli/release/rake_tasks.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 128

data/CHANGELOG.md

@@ -2,7 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
-## [v2.0.0](https://github.com/voxpupuli/voxpupuli-release/tree/v2.0.0) (2023-02-21)
+## [v3.0.0](https://github.com/voxpupuli/voxpupuli-release/tree/v3.0.0) (2023-05-09)
+
+[Full Changelog](https://github.com/voxpupuli/voxpupuli-release/compare/v2.0.0...v3.0.0)
+
+**Breaking changes:**
+
+- Drop Ruby 2.5/2.6 support; introduce voxpupuli-rubocop; cleanup CI [\#53](https://github.com/voxpupuli/voxpupuli-release/pull/53) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Avoid producing a backtrace for deprecated tasks [\#52](https://github.com/voxpupuli/voxpupuli-release/pull/52) ([smortex](https://github.com/smortex))
+
+**Merged pull requests:**
+
+- gemspec: Add version constraints for dependencies & build gem with strictness and verbosity [\#54](https://github.com/voxpupuli/voxpupuli-release/pull/54) ([bastelfreak](https://github.com/bastelfreak))
+
+## [v2.0.0](https://github.com/voxpupuli/voxpupuli-release/tree/v2.0.0) (2023-02-22)
 
 [Full Changelog](https://github.com/voxpupuli/voxpupuli-release/compare/v1.3.0...v2.0.0)
 
@@ -21,6 +37,7 @@ All notable changes to this project will be documented in this file.
 
 **Merged pull requests:**
 
+- Bump actions/checkout from 2 to 3 [\#50](https://github.com/voxpupuli/voxpupuli-release/pull/50) ([dependabot[bot]](https://github.com/apps/dependabot))
 - dependabot: check for github actions as well [\#49](https://github.com/voxpupuli/voxpupuli-release/pull/49) ([bastelfreak](https://github.com/bastelfreak))
 - Add Ruby 3.2 to CI matrix [\#48](https://github.com/voxpupuli/voxpupuli-release/pull/48) ([bastelfreak](https://github.com/bastelfreak))
 - Replace `Depreciated` with `Deprecated` [\#47](https://github.com/voxpupuli/voxpupuli-release/pull/47) ([alexjfisher](https://github.com/alexjfisher))

data/Gemfile

@@ -3,5 +3,6 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 gemspec
 
 group :release, optional: true do
-  gem 'github_changelog_generator', '>= 1.16.1',  :require => false if RUBY_VERSION >= '2.5.0'
+  gem 'faraday-retry', '~> 2.1', require: false
+  gem 'github_changelog_generator', '~> 1.16.4', require: false
 end

data/Rakefile

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'voxpupuli/release/version'
 
-task :default => :dummy
+task default: :dummy
 
 desc 'Dummy rake task'
 task 'dummy' do
@@ -10,13 +10,21 @@ end
 
 begin
   require 'github_changelog_generator/task'
+rescue LoadError
+  # github_changelog_generator is an optional group
+else
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
     version = Voxpupuli::Release::VERSION
-    config.future_release = "v#{version}" if version =~ /^\d+\.\d+.\d+$/
+    config.future_release = "v#{version}" if /^\d+\.\d+.\d+$/.match?(version)
     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.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
     config.user = 'voxpupuli'
     config.project = 'voxpupuli-release'
   end
+end
+
+begin
+  require 'voxpupuli/rubocop/rake'
 rescue LoadError
+  # the voxpupuli-rubocop gem is optional
 end

data/lib/voxpupuli/release/rake_tasks.rb

@@ -1,16 +1,16 @@
 require 'puppet_blacksmith/rake_tasks'
 
 class GCGConfig
-  def self.user=(user)
-    @user = user
+  class << self
+    attr_writer :user
   end
 
   def self.user
     @user || project.split(%r{[-/]}).first
   end
 
-  def self.project=(project)
-    @project = project
+  class << self
+    attr_writer :project
   end
 
   def self.project
@@ -22,8 +22,8 @@ class GCGConfig
     @metadata ||= Blacksmith::Modulefile.new.metadata
   end
 
-  def self.tag_pattern=(tag_pattern)
-    @tag_pattern = tag_pattern
+  class << self
+    attr_writer :tag_pattern
   end
 
   def self.tag_pattern
@@ -46,29 +46,31 @@ task :release do
   Blacksmith::RakeTask.new do |t|
     t.build = false # do not build the module nor push it to the Forge
     t.tag_sign = true # sign release with gpg
-    t.tag_message_pattern = "Version %s" # required tag message for gpg-signed tags
+    t.tag_message_pattern = 'Version %s' # required tag message for gpg-signed tags
     # just do the tagging [:clean, :tag, :bump_commit]
   end
 
   m = Blacksmith::Modulefile.new
   v = m.version
-  raise "Refusing to release an RC or build-release (#{v}).\n" +
-        "Please set a semver *release* version." unless v.match?(/^\d+\.\d+.\d+$/)
+  unless v.match?(/^\d+\.\d+.\d+$/)
+    raise "Refusing to release an RC or build-release (#{v}).\n" +
+          'Please set a semver *release* version.'
+  end
 
   # validate that the REFERENCE.md is up2date, if it exists
   Rake::Task['strings:validate:reference'].invoke if File.exist?('REFERENCE.md')
   Rake::Task[:check_changelog].invoke
   # do a "manual" module:release (clean, tag, bump, commit, push tags)
-  Rake::Task["module:clean"].invoke
+  Rake::Task['module:clean'].invoke
 
   # idempotently create tags
   g = Blacksmith::Git.new
-  Rake::Task["module:tag"].invoke unless g.has_version_tag?(v)
+  Rake::Task['module:tag'].invoke unless g.has_version_tag?(v)
 
   v_inc = m.increase_version(v)
   v_new = "#{v_inc}-rc0"
   ENV['BLACKSMITH_FULL_VERSION'] = v_new
-  Rake::Task["module:bump:full"].invoke
+  Rake::Task['module:bump:full'].invoke
 
   # push it out, and let GitHub Actions do the release:
   g.commit_modulefile!(v_new)
@@ -76,8 +78,8 @@ task :release do
 end
 
 desc 'Deprecated: use the "release" task instead'
-task "travis_release" do
-  STDERR.puts "Deprecated: use the 'release' task instead"
+task 'travis_release' do
+  warn "Deprecated: use the 'release' task instead"
   Rake::Task['release'].invoke
 end
 
@@ -89,16 +91,16 @@ task :check_changelog do
   # ## 2016-11-20 Release 4.0.2
   # ## [v4.0.3-rc0](https://github.com/voxpupuli/puppet-r10k/tree/v4.0.3-rc0) (2016-12-13)
   # ## [2.1.0](https://github.com/opus-codium/puppet-odoo/tree/2.1.0) (2021-12-02)
-  if File.readlines('CHANGELOG.md').grep( /^(#.+[Rr]eleas.+#{Regexp.escape(v)}|## \[v?#{Regexp.escape(v)}\])/ ).empty?
-    fail "Unable to find a CHANGELOG.md entry for the #{v} release."
+  if File.readlines('CHANGELOG.md').grep(/^(#.+[Rr]eleas.+#{Regexp.escape(v)}|## \[v?#{Regexp.escape(v)}\])/).empty?
+    raise "Unable to find a CHANGELOG.md entry for the #{v} release."
   end
 end
 
 namespace :release do
-  desc "Prepare a release"
+  desc 'Prepare a release'
   task prepare: ['release:porcelain:changelog'] do
     v = Blacksmith::Modulefile.new.version
-    Rake::Task["strings:generate:reference"].invoke if File.exist?('REFERENCE.md')
+    Rake::Task['strings:generate:reference'].invoke if File.exist?('REFERENCE.md')
     puts <<~MESSAGE
 
       Please review these changes and commit them to a new branch:
@@ -111,64 +113,64 @@ namespace :release do
   end
 
   namespace :porcelain do
-    begin
-      require 'github_changelog_generator/task'
-    rescue LoadError
-      desc "Dummy"
-      task :changelog do
-        puts "Skipping CHANGELOG.md generation.  Ensure github_changelog_generator is present if you expected it to be generated."
-      end
-    else
-      task :changelog do
-        # This is taken from lib/github_changelog_generator/task
-        # The generator cannot be used because we want to lazyly evaluate
-        # GCGConfig.user which might be overrider in the module Rakefile.
-        options = GitHubChangelogGenerator::Parser.default_options
-        options[:user] = GCGConfig.user
-        options[:project] = GCGConfig.project
-        options[:future_release] = GCGConfig.future_release
-        options[:header] = <<~HEADER.chomp
-          # Changelog
-
-          All notable changes to this project will be documented in this file.
-          Each new release typically also includes the latest modulesync defaults.
-          These should not affect the functionality of the module.
-        HEADER
-        options[:exclude_labels] = %w{duplicate question invalid wontfix wont-fix modulesync skip-changelog}
-        generator = GitHubChangelogGenerator::Generator.new(options)
-        log = generator.compound_changelog
-        output_filename = options[:output].to_s
-
-        # Workaround for https://github.com/github-changelog-generator/github-changelog-generator/issues/715
-        require 'rbconfig'
-        unless RbConfig::CONFIG['host_os'].match?(/windows/)
-          puts 'Fixing line endings...'
-          log.gsub!("\r\n", "\n")
-        end
-
-        File.write(output_filename, log)
-        puts "Generated log placed in #{File.absolute_path(output_filename)}"
+    require 'github_changelog_generator/task'
+  rescue LoadError
+    desc 'Dummy'
+    task :changelog do
+      puts 'Skipping CHANGELOG.md generation.  Ensure github_changelog_generator is present if you expected it to be generated.'
+    end
+  else
+    task :changelog do
+      # This is taken from lib/github_changelog_generator/task
+      # The generator cannot be used because we want to lazyly evaluate
+      # GCGConfig.user which might be overrider in the module Rakefile.
+      options = GitHubChangelogGenerator::Parser.default_options
+      options[:user] = GCGConfig.user
+      options[:project] = GCGConfig.project
+      options[:future_release] = GCGConfig.future_release
+      options[:header] = <<~HEADER.chomp
+        # Changelog
+
+        All notable changes to this project will be documented in this file.
+        Each new release typically also includes the latest modulesync defaults.
+        These should not affect the functionality of the module.
+      HEADER
+      options[:exclude_labels] = %w[duplicate question invalid wontfix wont-fix modulesync skip-changelog]
+      generator = GitHubChangelogGenerator::Generator.new(options)
+      log = generator.compound_changelog
+      output_filename = options[:output].to_s
+
+      # Workaround for https://github.com/github-changelog-generator/github-changelog-generator/issues/715
+      require 'rbconfig'
+      unless RbConfig::CONFIG['host_os'].match?(/windows/)
+        puts 'Fixing line endings...'
+        log.gsub!("\r\n", "\n")
       end
+
+      File.write(output_filename, log)
+      puts "Generated log placed in #{File.absolute_path(output_filename)}"
     end
   end
 end
 
 # For backward compatibility
 task :changelog do
-  fail <<-ERROR
+  warn <<-ERROR
   The "changelog" task is deprecated.
 
   Prefer "release:prepare" which manage all pre-release steps, or directly run
   the "release:porcelain:changelog" task.
   ERROR
+  exit(1)
 end
 
 # For backward compatibility
 task :reference do
-  fail <<-ERROR
+  warn <<-ERROR
   The "reference" task is deprecated.
 
   Prefer "release:prepare" which manage all pre-release steps, or directly run
   the "strings:generate:reference" task.
   ERROR
+  exit(1)
 end

data/lib/voxpupuli/release/version.rb

@@ -1,5 +1,5 @@
 module Voxpupuli
   module Release
-    VERSION = '2.0.0'
+    VERSION = '3.0.0'
   end
 end

data/voxpupuli-release.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'voxpupuli/release/version'
 
 Gem::Specification.new do |s|
@@ -9,17 +8,17 @@ Gem::Specification.new do |s|
   s.email       = ['voxpupuli@groups.io']
   s.homepage    = 'https://github.com/voxpupuli/voxpupuli-release'
   s.summary     = 'Helpers for deploying Vox Pupuli modules'
-  s.description = s.summary
   s.licenses    = 'Apache-2.0'
 
-  s.required_ruby_version = '>= 2.5', '< 4'
+  s.required_ruby_version = '>= 2.7', '< 4'
 
   s.files       = `git ls-files`.split("\n")
-  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
 
   # Runtime dependencies, but also probably dependencies of requiring projects
-  s.add_runtime_dependency 'rake'
-  s.add_runtime_dependency 'puppet-blacksmith', '>= 4.0.0'
-  s.add_runtime_dependency 'puppet-strings', '>= 2.9.0'
+  s.add_runtime_dependency 'puppet-blacksmith', '~> 7.0'
+  s.add_runtime_dependency 'puppet-strings', '~> 4'
+  s.add_runtime_dependency 'rake', '~> 13.0', '>= 13.0.6'
+
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 1.2'
 end

metadata

@@ -1,58 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-release
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: puppet-blacksmith
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: puppet-blacksmith
+  name: puppet-strings
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: puppet-strings
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 13.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.9.0
-description: Helpers for deploying Vox Pupuli modules
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
 email:
 - voxpupuli@groups.io
 executables: []
@@ -63,6 +83,8 @@ files:
 - ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -85,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'