cookbook-release 1.4.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3b086128b5edf30914681275eaae9561b8f88becde0c7a145504a67d75f3c54
-  data.tar.gz: 3db6bc505828795a5ca7af695fcd121dad92fe2470b3f28c1de96e750d238169
+  metadata.gz: e4b745baf2a010f96d7bd64dea31e9275f5d070cf871d738f0f1e9a6271a7554
+  data.tar.gz: 84360fb9192231adc36ef0e1031b7a4ca2cac799848a08efb6c270b7daa7943a
 SHA512:
-  metadata.gz: fd9f54971f71eedba8fce9a35f9b142fd83cb73959333614e36075a5b4f2ec51560da11f7eda6edb7769b5044d379afe6ee1bfa0c425cac02b41f7e9a53b0abe
-  data.tar.gz: 5fcfe52e2d656c3b372516b5ff92f7d14ef3679032372c514b29463230e17052caa40787bd22a3e16b974deadf63d02b7d1fd3ea8ee9923e03f9d905a2c3c67c
+  metadata.gz: 9278ffaf0ed6073d59b733e1c79c39a80b199874ba3f94318801805ba1f70508b019ae359926272183f862e0702c4d8596f98a095f10624592c0c2eb28ffd972
+  data.tar.gz: d08177747f17e1fb1c5a9527bd75b55be0bf9f9446e9e18529bf3d2121ed77427dbedd22d49d0b074f8d0e2d56a12dbff8d365ffcda4c5dbea7109fb43eab9ff

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
 rvm:
-  - 2.4
+- 2.4.0
 deploy:
   provider: rubygems
   api_key:
-    secure: nrEzm2dqWjyaa5ewApSonF+2D+y3PYwt9xaQC04d1NtbhQYyzX6wti3oatpMJI2gkcuuLjKrNHH/aLbKOGv7+Jj5BUJGOLixxhRdJyLWde/6cKCYVgIYPxeUtSJrRgyHAS2o8TDPjhWCT5oRwSkmhd+5D2JKjVqAycetbIzKWWvqScO09z0bF66bbKSfO1s44JwKjnUUW7W9tzrPvMPouBBoFtQ+dQVgxYLajgmjprVvIwzlHxgq/zP8YwL8i7vyRJFiQXyveSxZfBagN2qrUM72HWBPLLW4AeAdLDHYWon88GDU0p+cy2mVeSe67fBPVDopAEGij7MNJCBWV1/SRRKQcEb2U823+1GSB13OvaOGTn9rYsJP5zLKu77ATbHPi22nMfWOAzdEJJ+uFu9XW4nwUO/j79zPC1mEsRZDJlDrmTc4XZQJRKkCUjSl/J53vbdy4JQfos8B2V15tzx1baswQVPZuNiwuP4dOupI34FohJSVXQrsOoWVWVEX5Tfod6s3kpivW6lzwM68I2qXFa/4H8RPU2m0eVpfQslOO8TaGnbodudbQ1LSi/d5W6XWrMVqWGH910JG3jlJgHn5J7yQlI4VqnOpCjGsx/5xincuJZ7hBhcu5q5zcAGem7TrYSNkrx6neBYKmpZBHOWalIGw8wI9uViEsGQ6fayFee8=
+    secure: ylfB0GIaZxPfZ6/dSJIPujfSt3vxqVFg16lqTBq/2AAZ0qwKTZi9qeM/QZDLMX28vCXmTsYxHGepmyvv0PvJaKvy7E6YBzIKz1Y1vsEZFeAFrgIQq9cDvc4wIX2eFjI7N1ChyaRgi+YYK4BSVfKjYqGBfXk5Wyh7uqNEuWE7FzABV+RxXoHcNi+AhYkCX3NF80qNukXRtiB7XTQj6CP4Wd+Dm25iOUwx8/zNMce8Z8V3j2ysvR4Vtm/soDsr/+Z+27wIdP0VqwElV1FxtR9km8MIJhmzSsnzcvgqJpRmMvO6HLZFzwqnLBzCoPYJqm3K+uQSSfll5LbaNtixlBzIusgtGgm1UjQy1YDGkPexJd5K5CuC/LW78Y7Zrl3CeT34RDlICoztEjhJxFry3EvFxPT03lVQx5z5Fc55/u0hy3mBCiHbxHxAPJLMOtehfv35bzOS7Jv3+otBm/8jn9dXO2pJJdwxL9W2wrzljWkly4yemwceMvtMYf+xnf1zdTnMYoqkYGGl0KutbFL69w78w7BwTFQIhcJOO+g27C6V8vHtqU0U5JOgE/QNg3yWhzhQjgCpzQhmuO+Bcs3Jq2T/OcqTfwM6gufNe+Gq2TdEfeH5Y0WcRtTKJBVVQ4XWFtgONE1C1hNBFLyh7GNZDQQVYBT3c/MXeV5Q++rVJYOdSrw=
   gem: cookbook-release
   on:
     tags: true
     repo: criteo/cookbook-release
+  skip_cleanup: 'true'

data/cookbook-release.gemspec

@@ -6,7 +6,7 @@ require 'English'
 
 Gem::Specification.new do |spec|
   spec.name          = 'cookbook-release'
-  spec.version       = '1.4.2'
+  spec.version       = '1.6.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.rb

@@ -56,6 +56,12 @@ module CookbookRelease
           git = GitUtilities.new('sub_dir': args['sub_dir'])
           puts Changelog.new(git, opts).markdown_priority
         end
+
+        desc 'Display markdown changelog between branches with risky commits on top and non-node-only changes separated'
+        task 'changelog:markdown_priority_nodes', [:sub_dir] do |_, args|
+          git = GitUtilities.new('sub_dir': args['sub_dir'])
+          puts Changelog.new(git, opts).markdown_priority_nodes
+        end
       end
     end
 

data/lib/cookbook-release/changelog.rb

@@ -4,11 +4,14 @@ module CookbookRelease
     DEFAULT_OPTS = {
       expand_major: true,
       expand_risky: true,
+      separate_nodes: true,
       short_sha: true
     }
 
     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:'
 
@@ -42,6 +45,7 @@ module CookbookRelease
       result << changelog.map do |c|
         full_body ||= @opts[:expand_major] && c.major?
         full_body ||= @opts[:expand_risky] && c.risky?
+        full_body ||= @opts[:separate_nodes] && c.nodes_only?
         full_body ||= @opts[:expand_commit] && (c[:subject] =~ @opts[:expand_commit] || c[:body] =~ @opts[:expand_commit])
         c.to_s_html(full_body)
       end.map { |c| "    <p>#{c}</p>" }
@@ -81,6 +85,8 @@ module CookbookRelease
       changelog.map do |c|
         full_body ||= @opts[:expand_major] && c.major?
         full_body ||= @opts[:expand_risky] && c.risky?
+        full_body ||= @opts[:separate_nodes] && c.nodes_only?
+        full_body ||= @opts[:expand_commit] && (c[:subject] =~ @opts[:expand_commit] || c[:body] =~ @opts[:expand_commit])
         full_body ||= @opts[:expand_commit] && (c[:subject] =~ @opts[:expand_commit] || c[:body] =~ @opts[:expand_commit])
         c.to_s_markdown(full_body)
       end.join("\n")
@@ -103,8 +109,55 @@ module CookbookRelease
       result
     end
 
+    def markdown_priority_nodes
+      result = []
+      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?
+        txt = not_nodes_only_commits.map { |c| c.to_s_markdown(false) }.join("\n")
+        output << "*#{NON_NODES_ONLY}*\n#{txt}\n"
+      end
+      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?
+        "\n#{DETAILS}\n" + risky_commits.map { |c| c.to_s_markdown(true) }.join("\n")
+      else
+        ''
+      end
+    end
+
+    # @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'
       @git.compute_changelog(ref, @opts[:short_sha])

data/lib/cookbook-release/commit.rb

@@ -1,3 +1,6 @@
+require 'forwardable'
+require 'unicode/emoji'
+
 module CookbookRelease
   class Commit
     extend Forwardable
@@ -34,6 +37,10 @@ module CookbookRelease
       !!(self[:subject] =~ /\[risky\]/i)
     end
 
+    def nodes_only?
+      self[:nodes_only]
+    end
+
     def color
       case true
       when major?
@@ -75,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

@@ -23,6 +23,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 +52,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 +75,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,
@@ -72,7 +84,10 @@ module CookbookRelease
           subject: message.delete_at(0),
           hash: short_sha ? commit.sha[0,7] : commit.sha,
           body: message.empty? ? nil : message.join("\n"),
-          is_merge_commit: commit.parents.length > 1
+          is_merge_commit: commit.parents.length > 1,
+          nodes_only: @g.diff(commit.sha, "#{commit.sha}~1").name_status.reject do |path, change_type|
+            path.include?('nodes/') && ['A', 'D'].include?(change_type) # basic node additions or deletions only
+          end.count.zero?
         )
       end.reject { |commit| commit[:is_merge_commit] }
     end

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

data/spec/changelog_spec.rb

@@ -55,5 +55,40 @@ describe CookbookRelease::Changelog do
         expect(changelog.markdown).to start_with('*654321* @j.doe `[Risky] hello`')
       end
     end
+    context 'Separates risky and non-risky+non-nodes' do
+      let(:commits) do
+        [
+          CookbookRelease::Commit.new(
+            hash: '654321',
+            subject: 'hello',
+            author: 'John Doe',
+            email: 'j.doe@nobody.com',
+            body: 'New Men Just Want to Watch the World Burn',
+            nodes_only: false),
+          CookbookRelease::Commit.new(
+            hash: '654321',
+            subject: '[Risky] hello',
+            author: 'John Doe',
+            email: 'j.doe@nobody.com',
+            body: 'Some Men Just Want to Watch the World Turn',
+            nodes_only: true),
+          CookbookRelease::Commit.new(
+            hash: '654321',
+            subject: 'hello only nodes',
+            author: 'John Doe',
+            email: 'j.doe@nobody.com',
+            body: 'Old Men Just Want to Watch the World Learn',
+            nodes_only: true)
+        ]
+      end
+
+      it 'expands the body with non-risky+non-nodes' do
+        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*Commits impacting only nodes"
+        )
+      end
+    end
   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)
@@ -183,5 +198,32 @@ git tag 12.34.56
       changelog = git.compute_changelog('HEAD~1', false)
       expect(changelog[0][:hash].size).to eq(40)
     end
+
+    it 'detects node-only commits' do
+      cmds = <<-EOH
+      mkdir -p nodes/preprod
+      echo "hello first" > nodes/preprod/tata.rb
+      git add nodes/preprod/tata.rb
+      git commit -m "hello there"
+      echo "hello second" > nodes/preprod/tata.rb
+      git add nodes/preprod/tata.rb
+      git commit -m "hello there modify"
+      mkdir -p toto
+      echo "hello" > toto/titi.rb
+      git add toto/titi.rb
+      git commit -m "subject" -m "body" -m "line2"
+      EOH
+      cmds.split("\n").each do |cmd|
+        cmd = Mixlib::ShellOut.new(cmd)
+        cmd.run_command
+        cmd.error!
+      end
+
+      git = CookbookRelease::GitUtilities.new
+      changelog = git.compute_changelog('HEAD~3')
+      expect(changelog[0][:nodes_only]).to be false # Add a non-"nodes" file
+      expect(changelog[1][:nodes_only]).to be false # Modify a "nodes" file
+      expect(changelog[2][:nodes_only]).to be true # Add a "nodes" file
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cookbook-release
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Grégoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2021-06-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
@@ -181,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Provide primitives (and rake tasks) to release a cookbook