cookbook-release 1.4.5 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d320d81b00bbc0568db5a101bf05cb341ffc23aed196a0d82a08a37c2921ccd
-  data.tar.gz: a66c146cce4f56369b30329f810d0de829abe85fcfe79f9760d0f445547d3a65
+  metadata.gz: f7437fec8e18c6f3d3010cabcc1560d2f50a21fa9f3d3721fea2e11fbfa41245
+  data.tar.gz: 528a77af3764cabb0ea07cb41b1d21c52e2ff57a306ce4924d129ee657da5522
 SHA512:
-  metadata.gz: a8d578db88940e2a0552cd74a203e104693ec1377b97db12fbf29ea15aed8e58e1fb1e967bc3226a8fb45a5689c24ab69d7826fd96a6935fdfc9d908b38f540d
-  data.tar.gz: febc04990a5974dd9305874332443155069f3f044d562fb5297b805345554b2ba62bac2b2e389bbde73bf396b1ef49b2caceddde7ec21b3501d4202d11aed7c7
+  metadata.gz: 14d6f53eab37b49ee1b5336e23f1f05fe4145b4f8b28610645d5418a9e8b18617081060fb5c96bc79ccc2136a2a890c1f0068403e065e9136ea1ea6a0d10ca92
+  data.tar.gz: 5a5b26e7d8035f611a5a79dc03523d81ff8d9b87f97728ebcb9de3d3e9846d8b5b639c4c90b368355da887f42be209b3c934e1fccc9ebe2fcef1921def5d57f0

data/cookbook-release.gemspec

@@ -6,7 +6,7 @@ require 'English'
 
 Gem::Specification.new do |spec|
   spec.name          = 'cookbook-release'
-  spec.version       = '1.4.5'
+  spec.version       = '1.4.6'
   spec.authors       = ['Grégoire Seux']
   spec.email         = 'g.seux@criteo.com'
   spec.summary       = 'Provide primitives (and rake tasks) to release a cookbook'

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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cookbook-release
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors:
 - Grégoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic
@@ -194,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Provide primitives (and rake tasks) to release a cookbook