cookbook-release 1.4.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48e42c04f5d4ac5f465c53eebb18921398ba5212f39cf0fa6207e6377e3b162
-  data.tar.gz: 684da15c491938a19b473ddcd997d428830631c11a0a174b70dcf02bf1dbba9d
+  metadata.gz: 59ea3c1e5d1d222c334a409f63333f4a7339cebc36655043656fd1c26c78ec2f
+  data.tar.gz: 59d2e2dfb5db2d3bd9e28fc341b0839c0fdb63a0d8483764528cb2bede290320
 SHA512:
-  metadata.gz: 2a2455d339262c0e83172ee37af3ff81f224139915022a97dcbbbac2ea8d8b45e754af7dcf7a913c612418d63614848ce7c0fc6d957bddddb77cb01515f66eef
-  data.tar.gz: 4fd577bd939752c1ddf96d003f9c521b2c186b2e3ce9333046cfb1a0d5c2c3c8b0e2415d26aa4183955ed1ab0625559755e1b13cc783099224985cb3b4a2d528
+  metadata.gz: 5b292dadbf789958681065228a9732c0614008e9cca74a8e3bcf478cbbf42da2c0bef73f8a6ad2ae52309b0ac47573a6038ddd62480fb4c73afdab76616be4f1
+  data.tar.gz: 5f856842d4d1588c21d3961d29f9346b8b41000e3054933dcfbdba830a3811703b5894b6ac41cdd530e9bb6d2e6a8911eb65874cfd423dfc0b98c2dc82f2f58f

data/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.7']
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Release
+on:
+  push:
+    tags: [ '*' ]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - run: |
+        install -D -m 600 <(echo -e "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}") $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/cookbook-release.gemspec

@@ -6,7 +6,7 @@ require 'English'
 
 Gem::Specification.new do |spec|
   spec.name          = 'cookbook-release'
-  spec.version       = '1.4.3'
+  spec.version       = '1.7.0'
   spec.authors       = ['Grégoire Seux']
   spec.email         = 'g.seux@criteo.com'
   spec.summary       = 'Provide primitives (and rake tasks) to release a cookbook'
@@ -22,8 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'semantic'
   spec.add_dependency 'highline'
   spec.add_dependency 'mixlib-shellout'
-  spec.add_dependency 'chef', '>= 12.18.31'
+  # TODO: support Chef 17 and leverage knife gem at some point
+  spec.add_dependency 'chef', '>= 12.18.31', '< 17.0' # knife code has been moved to dedicated gem starting with Chef 17
   spec.add_dependency 'git-ng' # see https://github.com/schacon/ruby-git/issues/307
+  spec.add_dependency 'unicode-emoji'
 
 
   spec.add_development_dependency 'rspec'

data/lib/cookbook-release/changelog.rb

@@ -11,6 +11,7 @@ module CookbookRelease
     RISKY = 'RISKY/BREAKING (details below):'
     NO_RISKY = 'NO RISKY/BREAKING COMMITS. READ FULL CHANGELOG.'
     NON_NODES_ONLY = 'Non-risky/major, Non-node-only commits'
+    NODES_ONLY = 'Commits impacting only nodes'
     FULL = 'Full changelog:'
     DETAILS = 'Details of risky commits:'
 
@@ -109,28 +110,53 @@ module CookbookRelease
     end
 
     def markdown_priority_nodes
-      cl = changelog
-      risky_commits = cl.select { |c| c.risky? || c.major? }
-      not_nodes_only_commits = cl.reject { |c| c.nodes_only? || c.risky? || c.major? }
       result = []
-      if risky_commits.any?
-        result << "*#{RISKY}*\n" << risky_commits.map { |c| c.to_s_markdown(false) }.join("\n") << "\n"
-      else
-        result << "*#{NO_RISKY}*\n\n"
-      end
+      result << append_risky(changelog)
+      result << append_by_impact(changelog)
+      result << append_risky_details(changelog)
+      result
+    end
+
+    private
+
+    # @param changelog [Array<Commit>]
+    # @return [String] a string describing the changelog
+    def append_by_impact(changelog)
+      not_nodes_only_commits = changelog.reject { |c| c.nodes_only? || c.risky? || c.major? }
+      nodes_only_commits = changelog.select(&:nodes_only?)
+      output = []
       if not_nodes_only_commits.any?
-        result << "*#{NON_NODES_ONLY}*\n" << not_nodes_only_commits.map { |c| c.to_s_markdown(false) }.join("\n") << "\n"
+        txt = not_nodes_only_commits.map { |c| c.to_s_markdown(false) }.join("\n")
+        output << "*#{NON_NODES_ONLY}*\n#{txt}\n"
       end
-      result << "*#{FULL}*\n"
-      result << cl.map { |c| c.to_s_markdown(false) }.join("\n")
+      if nodes_only_commits.any?
+        txt = nodes_only_commits.map { |c| c.to_s_markdown(false) }.join("\n")
+        output << "*#{NODES_ONLY}*\n#{txt}\n"
+      end
+      output.join
+    end
+
+    # @param changelog [Array<Commit>]
+    # @return [String] a string describing the changelog
+    def append_risky_details(changelog)
+      risky_commits = changelog.select { |c| c.risky? || c.major? }
       if risky_commits.any?
-        result << "\n#{DETAILS}\n"
-        result << risky_commits.map { |c| c.to_s_markdown(true) }.join("\n")
+        "\n#{DETAILS}\n" + risky_commits.map { |c| c.to_s_markdown(true) }.join("\n")
+      else
+        ''
       end
-      result
     end
 
-    private
+    # @param changelog [Array<Commit>]
+    # @return [String] a string describing the changelog
+    def append_risky(changelog)
+      risky_commits = changelog.select { |c| c.risky? || c.major? }
+      if risky_commits.any?
+        "*#{RISKY}*\n" << risky_commits.map { |c| c.to_s_markdown(false) }.join("\n") << "\n"
+      else
+        "*#{NO_RISKY}*\n\n"
+      end
+    end
 
     def changelog
       ref = ENV['RELEASE_BRANCH'] || 'origin/master'

data/lib/cookbook-release/commit.rb

@@ -1,3 +1,6 @@
+require 'forwardable'
+require 'unicode/emoji'
+
 module CookbookRelease
   class Commit
     extend Forwardable
@@ -79,11 +82,20 @@ module CookbookRelease
       else
         result << "_#{self[:author]} <#{self[:email]}>_"
       end
-      result << " `#{self[:subject]}`"
+      result << ' '
+      result << backtick_string(self[:subject])
       result << "\n```\n#{strip_change_id(self[:body])}```" if full && self[:body]
       result
     end
 
+    def backtick_string(input)
+      s = input.gsub(/( )?(#{Unicode::Emoji::REGEX})( )?/, '` \2 `')
+               .gsub(/( )?``( )?/, '')
+      s += '`' unless s =~ /`$/
+      s = '`' + s unless s =~ /^`/
+      s
+    end
+
     private
 
     def strip_change_id(body)

data/lib/cookbook-release/git-utilities.rb

@@ -8,6 +8,7 @@ module CookbookRelease
   class GitUtilities
 
     attr_accessor :no_prompt
+    attr_reader :sub_dir
 
     def initialize(options={})
       @tag_prefix = options[:tag_prefix] || ''
@@ -23,6 +24,15 @@ module CookbookRelease
       File.directory?(::File.join(dir, '.git'))
     end
 
+    def self.find_root(dir = Dir.pwd)
+      # Do not consider given dir as part of the git repo if not in git hierarchy or dir is not tracked
+      return if ::Mixlib::ShellOut.new('git ls-files --error-unmatch .', cwd: dir).run_command.error?
+
+      cmd = Mixlib::ShellOut.new("git rev-parse --show-toplevel", cwd: dir)
+      cmd.run_command
+      cmd.error? ? nil : cmd.stdout.chomp
+    end
+
     def reset_command(new_version)
       remote = choose_remote
       "git tag -d #{new_version} ; git push #{remote} :#{new_version}"
@@ -43,11 +53,13 @@ module CookbookRelease
     def _compute_last_release
       tag = Mixlib::ShellOut.new([
         'git describe',
+        "--abbrev=0",
         "--tags",
         "--match \"#{@tag_prefix}[0-9]*\.[0-9]*\.[0-9]*\""
       ].join(" "), @shellout_opts)
       tag.run_command
-      tag.stdout.split('-').first
+      rel = tag.stdout.sub(/^#{@tag_prefix}/, '').chomp
+      rel.empty? ? nil : rel
     end
 
     def has_any_release?
@@ -64,7 +76,8 @@ module CookbookRelease
     end
 
     def compute_changelog(since, short_sha = true)
-      @g.log(500).object(@sub_dir).between(since, 'HEAD').map do |commit|
+      ref = "#{@tag_prefix}#{since}"
+      @g.log(500).object(@sub_dir).between(ref, 'HEAD').map do |commit|
         message = commit.message.lines.map(&:chomp).compact.delete_if(&:empty?)
         Commit.new(
           author: commit.author.name,

data/lib/cookbook-release/release.rb

@@ -5,13 +5,20 @@ module CookbookRelease
     def self.current_version(file)
       dir = File.dirname(file)
       version_file = File.join(dir, '.cookbook_version')
+      git_root = GitUtilities.find_root(dir)
 
-      if !GitUtilities.git?(dir)
+      if !GitUtilities.git?(dir) && git_root.nil?
         return File.read(version_file) if File.exist?(version_file)
         raise "Can't determine version in a non-git environment without #{version_file}"
       end
 
-      r = Release.new(GitUtilities.new(cwd: dir))
+      git = if git_root == dir
+              GitUtilities.new(cwd: dir)
+            else
+              GitUtilities.new(cwd: git_root, tag_prefix: "#{File.basename(dir)}-", sub_dir: dir)
+            end
+
+      r = Release.new(git)
       begin
         r.new_version.first
       rescue ExistingRelease
@@ -101,7 +108,7 @@ module CookbookRelease
         exit 1 unless agreed
         git.push_tag(new_version)
         supermarket = Supermarket.new
-        supermarket.publish_ck(@category)
+        supermarket.publish_ck(@category, git.sub_dir)
       rescue
         puts HighLine.color("Release aborted, you have to reset to previous state manually", :red)
         puts ":use with care: #{git.reset_command(new_version)}"

data/lib/cookbook-release/supermarket.rb

@@ -8,7 +8,7 @@ require 'json'
 module CookbookRelease
   class Supermarket
 
-    # This code is adapted from "knife cookbook share" and travis dpl provider 
+    # This code is adapted from "knife cookbook share" and travis dpl provider
     # for supermarket.
 
     def initialize(opts={})
@@ -20,11 +20,11 @@ module CookbookRelease
 
     include ::Chef::Mixin::ShellOut
 
-    def publish_ck(category)
-      ck = ::Chef::Cookbook::CookbookVersionLoader.new('.')
+    def publish_ck(category, path = nil)
+      ck = ::Chef::Cookbook::CookbookVersionLoader.new(path || '.')
       ck.load!
       cookbook = ck.cookbook_version
-      # we have to provide a rest option otherwise it will try to load a 
+      # we have to provide a rest option otherwise it will try to load a
       # client.pem key
       ::Chef::CookbookUploader.new(cookbook, rest: 'fake_rest').validate_cookbooks
 

data/spec/changelog_spec.rb

@@ -83,10 +83,10 @@ describe CookbookRelease::Changelog do
       end
 
       it 'expands the body with non-risky+non-nodes' do
-        expect(git).to receive(:compute_changelog).and_return(commits)
+        expect(git).to receive(:compute_changelog).and_return(commits).at_least(:once)
         changelog = CookbookRelease::Changelog.new(git, expand_risky: true, nodes_only: true)
         expect(changelog.markdown_priority_nodes.join('')).to include(
-          "\n*Non-risky/major, Non-node-only commits*\n*654321* _John Doe <j.doe@nobody.com>_ `hello`\n*Full"
+          "\n*Non-risky/major, Non-node-only commits*\n*654321* _John Doe <j.doe@nobody.com>_ `hello`\n*Commits impacting only nodes"
         )
       end
     end

data/spec/commit_spec.rb

@@ -23,4 +23,16 @@ describe CookbookRelease::Commit do
       expect(minor_change)   .not_to be_patch
     end
   end
+
+  describe '.to_s_markdown' do
+    it 'surrounds subject with backticks' do
+      commit = CookbookRelease::Commit.new(subject: 'This is a fix', hash: 'abcdef', author: 'Linus', email: 'linus@linux.org')
+      expect(commit.to_s_markdown(false)).to match(/`#{commit[:subject]}`/)
+    end
+
+    it 'properly handle emojis' do
+      commit = CookbookRelease::Commit.new(subject: 'This is a fix 🔧 and I love 🪐🚀', hash: 'abcdef', author: 'Linus', email: 'linus@linux.org')
+      expect(commit.to_s_markdown(false)).to match(/`This is a fix` 🔧 `and I love` 🪐🚀/)
+    end
+  end
 end

data/spec/git_spec.rb

@@ -44,6 +44,21 @@ describe CookbookRelease::GitUtilities do
       expect(CookbookRelease::GitUtilities.git?(tmp)).to be(true)
       FileUtils.rm_rf(tmp)
     end
+
+    it 'do not finds repo\'s root from untracked subdir' do
+      subdir = 'cookbooks/mycookbook'
+      FileUtils.mkdir_p(subdir)
+      expect(CookbookRelease::GitUtilities.find_root(subdir)).to be nil
+    end
+
+    it 'finds repo\'s root from tracked subdir' do
+      subdir = 'cookbooks/mycookbook'
+      tracked_file = ::File.join(subdir, 'tracked_file')
+      FileUtils.mkdir_p(subdir)
+      FileUtils.touch(tracked_file)
+      ::Mixlib::ShellOut.new("git add '#{tracked_file}'").run_command
+      expect(CookbookRelease::GitUtilities.find_root(subdir)).to eq(Dir.pwd)
+    end
   end
 
   describe '.clean_index(?|!)' do
@@ -150,8 +165,8 @@ git tag 12.34.56
 
     it 'parse correctly commits' do
       cmds = <<-EOH
-      git commit --allow-empty -m "subject" -m "body" -m "line2"
-      git commit --allow-empty -m "without body"
+      git commit --allow-empty --no-verify -m "subject" -m "body" -m "line2"
+      git commit --allow-empty --no-verify -m "without body"
       EOH
       cmds.split("\n").each do |cmd|
         cmd = Mixlib::ShellOut.new(cmd)

data/spec/release_spec.rb

@@ -36,12 +36,13 @@ describe Release do
                    :push_tag => true,
                   )
       allow(git).to receive(:no_prompt=)
+      allow(git).to receive(:sub_dir).and_return(nil)
       release = Release.new(git, no_prompt: true)
 
       supermarket = double('supermarket')
       expect(CookbookRelease::Supermarket).to receive(:new).and_return(supermarket)
 
-      expect(supermarket).to receive(:publish_ck).with('Other')
+      expect(supermarket).to receive(:publish_ck).with('Other', nil)
       release.release!
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cookbook-release
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Grégoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic
@@ -59,6 +59,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.18.31
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '17.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,6 +69,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.18.31
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '17.0'
 - !ruby/object:Gem::Dependency
   name: git-ng
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode-emoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,12 +162,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile.rb
+- Rakefile
 - cookbook-release.gemspec
 - lib/cookbook-release.rb
 - lib/cookbook-release/changelog.rb
@@ -180,8 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Provide primitives (and rake tasks) to release a cookbook

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-deploy:
-  provider: rubygems
-  api_key:
-    secure: nrEzm2dqWjyaa5ewApSonF+2D+y3PYwt9xaQC04d1NtbhQYyzX6wti3oatpMJI2gkcuuLjKrNHH/aLbKOGv7+Jj5BUJGOLixxhRdJyLWde/6cKCYVgIYPxeUtSJrRgyHAS2o8TDPjhWCT5oRwSkmhd+5D2JKjVqAycetbIzKWWvqScO09z0bF66bbKSfO1s44JwKjnUUW7W9tzrPvMPouBBoFtQ+dQVgxYLajgmjprVvIwzlHxgq/zP8YwL8i7vyRJFiQXyveSxZfBagN2qrUM72HWBPLLW4AeAdLDHYWon88GDU0p+cy2mVeSe67fBPVDopAEGij7MNJCBWV1/SRRKQcEb2U823+1GSB13OvaOGTn9rYsJP5zLKu77ATbHPi22nMfWOAzdEJJ+uFu9XW4nwUO/j79zPC1mEsRZDJlDrmTc4XZQJRKkCUjSl/J53vbdy4JQfos8B2V15tzx1baswQVPZuNiwuP4dOupI34FohJSVXQrsOoWVWVEX5Tfod6s3kpivW6lzwM68I2qXFa/4H8RPU2m0eVpfQslOO8TaGnbodudbQ1LSi/d5W6XWrMVqWGH910JG3jlJgHn5J7yQlI4VqnOpCjGsx/5xincuJZ7hBhcu5q5zcAGem7TrYSNkrx6neBYKmpZBHOWalIGw8wI9uViEsGQ6fayFee8=
-  gem: cookbook-release
-  on:
-    tags: true
-    repo: criteo/cookbook-release

data/Rakefile.rb

@@ -1,7 +0,0 @@
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
-
-task :default => :spec