circleci-bundle-update-pr 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 730944a68610db32ff05eed70a7679dd3eb435e6b70c5cd6a4e87a89635bbb45
-  data.tar.gz: e10e148aec42a589409f667a0a61acefc5d46025c4f78d1b608334d3eecabe55
+  metadata.gz: 241236ccdbb295ae0cdc591030ae68f962e60b39b8ca72dd90c1761ac2473a38
+  data.tar.gz: aeeafc7e65b66ad9e8042a88fe763d21ead19dc0b62bd971a7640f5b6f3a669e
 SHA512:
-  metadata.gz: 81cca2a76b7348417a52bad36b610be96355cf0748ca5a8df095575dfd431b1ba6538bf8ac9c7c6ba38080a121f91dd3458268f0c607be3a484e8e170f3455ed
-  data.tar.gz: 587c1b13c5d72cab5c3fb5c11ddb2c18ece7f41c5767f8eeab5bbfc19a609c476b8b5e2718dc92db22914e551ae2989daacf86a90a5bf78d4eb46fec7df59511
+  metadata.gz: df2bd5da29378b5f2608b942c33d484eeb772a05b13e6b6c1134ab907fa4d606c50d6db95d2e4636278d9b569b958e0a71d2647b186a84302b45d1ee31c29871
+  data.tar.gz: 971933e80b2149bbae90601d48ef6a56f3d0491d1f7a1cef4767a1f16c0962c0a1dc11372d66f77b1983d98164e16518b67d017f64861a2a53f60899acb4ea3c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    circleci-bundle-update-pr (1.13.0)
+    circleci-bundle-update-pr (1.14.0)
       compare_linker (>= 1.4.0)
       octokit
 
@@ -18,7 +18,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     httpclient (2.8.3)
     multipart-post (2.0.0)
-    octokit (4.12.0)
+    octokit (4.13.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     public_suffix (3.0.3)
     rake (12.3.1)
@@ -28,7 +28,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -51,4 +51,4 @@ DEPENDENCIES
   rspec (~> 3.7)
 
 BUNDLED WITH
-   1.16.5
+   1.16.6

data/README.md

@@ -118,6 +118,41 @@ Usage: circleci-bundle-update-pr [options]
     -d, --duplicate                  Make PR even if it has already existed
 ```
 
+## Tips
+
+### Customize PR description
+
+If `.circleci/BUNDLE_UPDATE_NOTE.md` exists, the content will be appended to PR description.
+
+e.g. `.circleci/BUNDLE_UPDATE_NOTE.md` is the below.
+
+```
+## Notice
+
+* example1
+* example2
+```
+
+PR description will be created as the below.
+
+```
+**Updated RubyGems:**
+
+* [ ] [octokit](https://github.com/octokit/octokit.rb): [`4.9.0...4.10.0`](https://github.com/octokit/octokit.rb/compare/v4.9.0...v4.10.0)
+* [ ] [public_suffix](https://github.com/weppos/publicsuffix-ruby): [`3.0.2...3.0.3`](https://github.com/weppos/publicsuffix-ruby/compare/v3.0.2...v3.0.3)
+
+Powered by [circleci-bundle-update-pr](https://rubygems.org/gems/circleci-bundle-update-pr)
+
+---
+
+## Notice
+
+* example1
+* example2
+```
+
+`.circleci/BUNDLE_UPDATE_NOTE.md` or `CIRCLECI_BUNDLE_UPDATE_NOTE.md`, either one is OK. It gives priority `.circleci/BUNDLE_UPDATE_NOTE.md` over `CIRCLECI_BUNDLE_UPDATE_NOTE.md`.
+
 ## Contributing
 
 1. Fork it ( https://github.com/masutaka/circleci-bundle-update-pr/fork )

data/lib/circleci/bundle/update/pr.rb

@@ -1,6 +1,7 @@
 require "circleci/bundle/update/pr/version"
 require "octokit"
 require "compare_linker"
+require "circleci/bundle/update/pr/note"
 
 module Circleci
   module Bundle
@@ -125,6 +126,15 @@ module Circleci
 Powered by [circleci-bundle-update-pr](https://rubygems.org/gems/circleci-bundle-update-pr)
           EOB
 
+          if Note.exist?
+            body << <<-EOB
+
+---
+
+#{Note.read}
+            EOB
+          end
+
           client.update_pull_request(repo_full_name, pr_number, body: body)
         end
         private_class_method :update_pull_request_body

data/lib/circleci/bundle/update/pr/note.rb

@@ -0,0 +1,24 @@
+module Circleci
+  module Bundle
+    module Update
+      module Pr
+        module Note
+          module_function
+
+          def exist?
+            File.exist?('.circleci/BUNDLE_UPDATE_NOTE.md') ||
+              File.exist?('CIRCLECI_BUNDLE_UPDATE_NOTE.md')
+          end
+
+          def read
+            if File.exist?('.circleci/BUNDLE_UPDATE_NOTE.md')
+              File.read('.circleci/BUNDLE_UPDATE_NOTE.md')
+            elsif File.exist?('CIRCLECI_BUNDLE_UPDATE_NOTE.md')
+              File.read('CIRCLECI_BUNDLE_UPDATE_NOTE.md')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/circleci/bundle/update/pr/version.rb

@@ -2,7 +2,7 @@ module Circleci
   module Bundle
     module Update
       module Pr
-        VERSION = "1.13.0"
+        VERSION = '1.14.0'
       end
     end
   end

data/spec/circleci/bundle/update/pr/note_spec.rb

@@ -0,0 +1,82 @@
+require 'tmpdir'
+
+describe Circleci::Bundle::Update::Pr::Note do
+  let!(:home_dir) { Dir.pwd }
+  let(:work_dir) { Dir.mktmpdir }
+
+  before do
+    Dir.chdir work_dir
+    Dir.mkdir '.circleci'
+  end
+
+  after do
+    Dir.chdir home_dir
+    FileUtils.rm_rf work_dir
+  end
+
+  describe '.exist?' do
+    subject { Circleci::Bundle::Update::Pr::Note.exist? }
+
+    context 'given only .circleci/BUNDLE_UPDATE_NOTE.md' do
+      before do
+        FileUtils.touch('.circleci/BUNDLE_UPDATE_NOTE.md')
+      end
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'given only CIRCLECI_BUNDLE_UPDATE_NOTE.md' do
+      before do
+        FileUtils.touch('CIRCLECI_BUNDLE_UPDATE_NOTE.md')
+      end
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'given .circleci/BUNDLE_UPDATE_NOTE.md and CIRCLECI_BUNDLE_UPDATE_NOTE.md' do
+      before do
+        FileUtils.touch('.circleci/BUNDLE_UPDATE_NOTE.md')
+        FileUtils.touch('CIRCLECI_BUNDLE_UPDATE_NOTE.md')
+      end
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'given nothing' do
+      it { is_expected.to be_falsy }
+    end
+  end
+
+  describe '.read' do
+    subject { Circleci::Bundle::Update::Pr::Note.read }
+
+    context 'given .circleci/BUNDLE_UPDATE_NOTE.md' do
+      before do
+        File.open('.circleci/BUNDLE_UPDATE_NOTE.md', 'w') { |f| f.write('I am .circleci/BUNDLE_UPDATE_NOTE.md') }
+      end
+
+      it { is_expected.to eq 'I am .circleci/BUNDLE_UPDATE_NOTE.md' }
+    end
+
+    context 'given CIRCLECI_BUNDLE_UPDATE_NOTE.md' do
+      before do
+        File.open('CIRCLECI_BUNDLE_UPDATE_NOTE.md', 'w') { |f| f.write('I am CIRCLECI_BUNDLE_UPDATE_NOTE.md') }
+      end
+
+      it { is_expected.to eq 'I am CIRCLECI_BUNDLE_UPDATE_NOTE.md' }
+    end
+
+    context 'given .circleci/BUNDLE_UPDATE_NOTE.md and CIRCLECI_BUNDLE_UPDATE_NOTE.md' do
+      before do
+        File.open('.circleci/BUNDLE_UPDATE_NOTE.md', 'w') { |f| f.write('I am .circleci/BUNDLE_UPDATE_NOTE.md') }
+        File.open('CIRCLECI_BUNDLE_UPDATE_NOTE.md', 'w') { |f| f.write('I am CIRCLECI_BUNDLE_UPDATE_NOTE.md') }
+      end
+
+      it { is_expected.to eq 'I am .circleci/BUNDLE_UPDATE_NOTE.md' }
+    end
+
+    context 'given nothing' do
+      it { is_expected.to be_nil }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci-bundle-update-pr
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Takashi Masuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-06 00:00:00.000000000 Z
+date: 2018-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -99,7 +99,9 @@ files:
 - bin/circleci-bundle-update-pr
 - circleci-bundle-update-pr.gemspec
 - lib/circleci/bundle/update/pr.rb
+- lib/circleci/bundle/update/pr/note.rb
 - lib/circleci/bundle/update/pr/version.rb
+- spec/circleci/bundle/update/pr/note_spec.rb
 - spec/circleci/bundle/update/pr_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/masutaka/circleci-bundle-update-pr
@@ -127,5 +129,6 @@ signing_key:
 specification_version: 4
 summary: Create GitHub PullRequest of bundle update in CircleCI
 test_files:
+- spec/circleci/bundle/update/pr/note_spec.rb
 - spec/circleci/bundle/update/pr_spec.rb
 - spec/spec_helper.rb