voxpupuli-release 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68c7470eabafe9c8941ecec6d75b2aaf3628449b6dd9f383123382647f660ce9
-  data.tar.gz: 47d9d4ee9fe3b313edd6b8014de524406fca3468b6f9381173733c44bf51dd88
+  metadata.gz: 356e4d7747c6128502901299af1fba19e71ea8b81b614d3a78a13b1c3d95be03
+  data.tar.gz: 15cf2e0e733939bc3e296647d8f12563dbbc8eefa674cf3f7cca804e2d69a02a
 SHA512:
-  metadata.gz: 4f71a39ddb592ca0a2e1300ddfcd615c531e39a3e5fba3e60e5563df140e18b7c508b722f2e3d3501d3ab1cf56b187fe7998e829d6a2e425ad2bd94bb939594c
-  data.tar.gz: fd07dcaa720bdd01a8d8602f54d25d73217f3e10733c6dd725f77ff3a4021c6dd7429a61d049e65ad9ac182b84358cbc020d313d631817acc03ba34955d688ec
+  metadata.gz: b216fc76ab233fcc2ee7cdb3cfc37305bf8261485df34b50c09d00035ed336992f3ca038f43a5cee2233717b520b27eb04e87d03b7ff3a01e4465670c3571d98
+  data.tar.gz: 221799d7e7a52e39c9d16fc65087358f49fd140c9635d5a769bf0af6dae9711e967593cd6f2fc4965760eca086121543964cddafd1a367c5e39221123f99a4b4

data/.github/dependabot.yml

@@ -1,8 +1,17 @@
 version: 2
 updates:
+# raise PRs for gem updates
 - package-ecosystem: bundler
   directory: "/"
   schedule:
     interval: daily
     time: "13:00"
   open-pull-requests-limit: 10
+
+# Maintain dependencies for GitHub Actions
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -14,14 +14,15 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - "2.4"
           - "2.5"
           - "2.6"
           - "2.7"
           - "3.0"
+          - "3.1"
+          - "3.2"
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -2,6 +2,39 @@
 
 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)
+
+[Full Changelog](https://github.com/voxpupuli/voxpupuli-release/compare/v1.3.0...v2.0.0)
+
+**Breaking changes:**
+
+- Drop Ruby 2.4 support [\#46](https://github.com/voxpupuli/voxpupuli-release/pull/46) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Rework release preparation tasks [\#44](https://github.com/voxpupuli/voxpupuli-release/pull/44) ([smortex](https://github.com/smortex))
+- Add Ruby 3.1 to CI matrix [\#43](https://github.com/voxpupuli/voxpupuli-release/pull/43) ([bastelfreak](https://github.com/bastelfreak))
+
+**Fixed bugs:**
+
+- README.md: Fix link to LICENSE file [\#42](https://github.com/voxpupuli/voxpupuli-release/pull/42) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- 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))
+- Add Test badge [\#45](https://github.com/voxpupuli/voxpupuli-release/pull/45) ([bastelfreak](https://github.com/bastelfreak))
+
+## [v1.3.0](https://github.com/voxpupuli/voxpupuli-release/tree/v1.3.0) (2021-12-08)
+
+[Full Changelog](https://github.com/voxpupuli/voxpupuli-release/compare/v1.2.1...v1.3.0)
+
+**Implemented enhancements:**
+
+- Allow no 'v' in release version [\#41](https://github.com/voxpupuli/voxpupuli-release/pull/41) ([smortex](https://github.com/smortex))
+- Validate REFERENCE.md if it exists [\#39](https://github.com/voxpupuli/voxpupuli-release/pull/39) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [v1.2.1](https://github.com/voxpupuli/voxpupuli-release/tree/v1.2.1) (2021-10-29)
 
 [Full Changelog](https://github.com/voxpupuli/voxpupuli-release/compare/v1.2.0...v1.2.1)

data/README.md

@@ -1,7 +1,8 @@
 # Vox Pupuli Release Gem
 
-[![License](https://img.shields.io/github/license/voxpupuli/voxpupuli-release.svg)](https://github.com/voxpupuli/voxpupuli-releasem/blob/master/LICENSE)
+[![License](https://img.shields.io/github/license/voxpupuli/voxpupuli-release.svg)](https://github.com/voxpupuli/voxpupuli-release/blob/master/LICENSE)
 [![Release](https://github.com/voxpupuli/voxpupuli-release/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-release/actions/workflows/release.yml)
+[![Test](https://github.com/voxpupuli/voxpupuli-release/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-release/actions/workflows/test.yml)
 [![RubyGem Version](https://img.shields.io/gem/v/voxpupuli-release.svg)](https://rubygems.org/gems/voxpupuli-release)
 [![RubyGem Downloads](https://img.shields.io/gem/dt/voxpupuli-release.svg)](https://rubygems.org/gems/voxpupuli-release)
 
@@ -21,12 +22,20 @@ Then, at the top of your `Rakefile`, add:
 require 'voxpupuli-release'
 ```
 
-To cut a new release of your module, ensure the `metadata.json` reflects the proper version. Also ensure that the `CHANGELOG.md` has a note about the release and that it actually is named Release or release, some old modules refer to it as Version, which won't work. Lastly check that no tag exists with that version number (format `v#.#.#`), and then run:
+To cut a new release of your module, ensure the `metadata.json` reflects the expected new version of the module, that no tag exists with that version number (format `v#.#.#`), and then update the module `CHANGELOG.md` and `REFERENCE.md` by running:
+
+```plain
+bundle exec rake release:prepare
+```
+
+Commit these changes (likely in a new branch, open a Pull-Request and wait for it to be reviewed and merged).  When ready to ship the new release, ensure you are on the main branch, it is up-to-date, and run:
 
 ```plain
 bundle exec rake release
 ```
 
+This will perform some sanity checks, tag the current commit with the version number, and bump the version number to ensure no conflict will happen by mistake.
+
 ## License
 
 This gem is licensed under the Apache-2 license.

data/lib/voxpupuli/release/rake_tasks.rb

@@ -1,5 +1,46 @@
 require 'puppet_blacksmith/rake_tasks'
 
+class GCGConfig
+  def self.user=(user)
+    @user = user
+  end
+
+  def self.user
+    @user || project.split(%r{[-/]}).first
+  end
+
+  def self.project=(project)
+    @project = project
+  end
+
+  def self.project
+    @project || metadata['name']
+  end
+
+  def self.metadata
+    require 'puppet_blacksmith'
+    @metadata ||= Blacksmith::Modulefile.new.metadata
+  end
+
+  def self.tag_pattern=(tag_pattern)
+    @tag_pattern = tag_pattern
+  end
+
+  def self.tag_pattern
+    @tag_pattern || 'v%s'
+  end
+
+  def self.future_release
+    if metadata['version'].match?(/^\d+\.\d+.\d+$/)
+      format(tag_pattern, metadata['version'])
+    else
+      # Not formatted like a release, might be a pre-release and the future
+      # changes should better be under an "unreleased" section.
+      nil
+    end
+  end
+end
+
 desc 'Release via GitHub Actions'
 task :release do
   Blacksmith::RakeTask.new do |t|
@@ -12,8 +53,10 @@ task :release do
   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 =~ /^\d+\.\d+.\d+$/
+        "Please set a semver *release* version." unless v.match?(/^\d+\.\d+.\d+$/)
 
+  # 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
@@ -32,9 +75,9 @@ task :release do
   g.push!
 end
 
-desc 'Depreciated: use the "release" task instead'
+desc 'Deprecated: use the "release" task instead'
 task "travis_release" do
-  STDERR.puts "Depreciated: use the 'release' task instead"
+  STDERR.puts "Deprecated: use the 'release' task instead"
   Rake::Task['release'].invoke
 end
 
@@ -45,7 +88,87 @@ 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)
-  if File.readlines('CHANGELOG.md').grep( /^(#.+[Rr]eleas.+#{Regexp.escape(v)}|## \[v#{Regexp.escape(v)}\])/ ).size == 0
+  # ## [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."
   end
 end
+
+namespace :release do
+  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')
+    puts <<~MESSAGE
+
+      Please review these changes and commit them to a new branch:
+
+          git checkout -b release-#{v}
+          git commit -m "Release #{v}"
+
+      Then open a Pull-Request and wait for it to be reviewed and merged).
+    MESSAGE
+  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)}"
+      end
+    end
+  end
+end
+
+# For backward compatibility
+task :changelog do
+  fail <<-ERROR
+  The "changelog" task is deprecated.
+
+  Prefer "release:prepare" which manage all pre-release steps, or directly run
+  the "release:porcelain:changelog" task.
+  ERROR
+end
+
+# For backward compatibility
+task :reference do
+  fail <<-ERROR
+  The "reference" task is deprecated.
+
+  Prefer "release:prepare" which manage all pre-release steps, or directly run
+  the "strings:generate:reference" task.
+  ERROR
+end

data/lib/voxpupuli/release/version.rb

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

data/voxpupuli-release.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |s|
   s.description = s.summary
   s.licenses    = 'Apache-2.0'
 
+  s.required_ruby_version = '>= 2.5', '< 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) }
@@ -19,4 +21,5 @@ Gem::Specification.new do |s|
   # 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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-release
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: puppet-strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 description: Helpers for deploying Vox Pupuli modules
 email:
 - voxpupuli@groups.io
@@ -71,14 +85,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Helpers for deploying Vox Pupuli modules