git-pr-release 1.8.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd65bf0b5593cadffc3eaca21920f47a60e98326f5e2a020663c2327052dea0e
-  data.tar.gz: 2d6e584fcab1cb4fa1682b3b420c846182cf4e7e7bf240beb82ca0e2666aa00f
+  metadata.gz: e1a94b83554ecc020acc0a736dcec3d764e416cd0a99ea2b3a1948b9b2a85fb6
+  data.tar.gz: 2d41363fc87ca3d42e21b8bf18348f2ff9ef6f2e4a53237c4292338e62a9e257
 SHA512:
-  metadata.gz: fb186c01e62ac87de4b1e808fbd8e25b42666c3066630cfb4de2ee5deaf133deacc1960df6cbf92080eaa2da881feec18ebaa4a5df7efe5408abcb9c23b7f046
-  data.tar.gz: b053c6e80448961020cf67d3de61e8115950703f4ace3e5caacc9348a7893661bbc33615426d1ac32fa21e26f59ed4bf220fe83db4cbcd133e85bf283abdc8a8
+  metadata.gz: fbb6731c6b4805a9bf512d727641a8e73bc4bf50261c2e821d1a17beeba359a1c2c2ed234269c7b4e05d3d08378ad225ad84955008c055ad6c7bbbe0993db43f
+  data.tar.gz: ac651dbda5be13ed6fd43db65baee451e5dba97723c79c7eaa7ca44c1214500651a10a93f8e8c911062d772c8ead1726edcb5c06a1bf2c9214ff1380406b827d

data/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *" # JST 09:00
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - ruby:2.6
+          - ruby:2.7
+          - ruby:3.0
+          - rubylang/ruby:master-nightly-bionic
+        include:
+          - ruby: rubylang/ruby:master-nightly-bionic
+            allow_failures: "true"
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache vendor/bundle
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: v1-gem-${{ runner.os }}-${{ matrix.ruby }}-${{ github.sha }}
+          restore-keys: |
+            v1-gem-${{ runner.os }}-${{ matrix.ruby }}-
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - name: bundle update
+        run: |
+          set -xe
+          bundle config path vendor/bundle
+          bundle update --jobs $(nproc) --retry 3
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - name: Run ${{ matrix.test_framework }}
+        run: |
+          set -xe
+          bundle exec rspec
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # git-pr-release
 
+## v2.1.0 (2022-03-03)
+
+[full changelog](https://github.com/x-motemen/git-pr-release/compare/v2.0.0...v2.1.0)
+
+* (#75) reduce GitHub search API calls when the squashed option is specified (@Songmu)
+* (#76) use bulk issue search to reduce API calls (@Songmu)
+* (#77) Add option "ssl_no_verify" to skip verifying ssl certificate (@mtgto)
+* (#78) add an argument to to_checklist_item to print pr title (@mtgto)
+
+## v2.0.0 (2022-02-17)
+
+[full changelog](https://github.com/x-motemen/git-pr-release/compare/v1.9.0...v2.0.0)
+
+* (#69) remove duplicated PR entries at squash (@Yuki-Inoue)
+* (#70) [Spec] Fix spec for build_pr_title_and_body (@yutailang0119)
+* (#71) Introduce CI (@ohbarye)
+* (#73) (#74) Use `YAML.unsafe_load_file` instead of `YAML.load_file` (@ohbarye)
+
+## v1.9.0 (2021-08-04)
+
+[full changelog](https://github.com/x-motemen/git-pr-release/compare/v1.8.0...v1.9.0)
+
+* (#68) Add nil check for release\_pr.body (@w1mvy)
+
 ## v1.8.0 (2021-06-24)
 
 [full changelog](https://github.com/x-motemen/git-pr-release/compare/v1.7.0...v1.8.0)

data/README.md

@@ -84,6 +84,16 @@ You can specify this value by `GIT_PR_RELEASE_MENTION` environment variable.
 
 If not specified, the mention will be the PR assignee
 
+## `pr-release.ssl_no_verify`
+
+Whether to verify SSL certificate or not.
+Accepted values: `true` | `false`
+
+This option might be useful when self-hosted GitHub enterprise server is using self-signed certificate.
+
+You can specify this value by `GIT_PR_RELEASE_SSL_NO_VERIFY` to `1`.
+
+If not specified, verify SSL certificate always.
 
 Errors and exit statuses
 ------------------------

data/git-pr-release.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "git-pr-release"
-  spec.version       = '1.8.0'
+  spec.version       = '2.1.0'
   spec.authors       = ["motemen"]
   spec.email         = ["motemen@gmail.com"]
   spec.summary       = 'Creates a release pull request'

data/lib/git/pr/release/cli.rb

@@ -59,8 +59,12 @@ module Git
           host, @repository, scheme = host_and_repository_and_scheme
 
           if host
-            # GitHub:Enterprise
-            OpenSSL::SSL.const_set :VERIFY_PEER, OpenSSL::SSL::VERIFY_NONE # XXX
+            if host != 'github.com' && scheme == 'https' # GitHub Enterprise
+              ssl_no_verify = %w[true 1].include? ENV.fetch('GIT_PR_RELEASE_SSL_NO_VERIFY') { git_config('ssl_no_verify') }
+              if ssl_no_verify
+                OpenSSL::SSL.const_set :VERIFY_PEER, OpenSSL::SSL::VERIFY_NONE
+              end
+            end
 
             Octokit.configure do |c|
               c.api_endpoint = "#{scheme}://#{host}/api/v3"
@@ -85,9 +89,12 @@ module Git
         def fetch_merged_prs
           git :remote, 'update', 'origin' unless @no_fetch
 
-          merged_pull_request_numbers = @squashed ? fetch_merged_pr_numbers_from_github : fetch_merged_pr_numbers_from_git_remote
+          merged_pull_request_numbers = fetch_merged_pr_numbers_from_git_remote
+          if @squashed
+            merged_pull_request_numbers.concat(fetch_squash_merged_pr_numbers_from_github)
+          end
 
-          merged_prs = merged_pull_request_numbers.sort.map do |nr|
+          merged_prs = merged_pull_request_numbers.uniq.sort.map do |nr|
             pr = client.pull_request repository, nr
             say "To be released: ##{pr.number} #{pr.title}", :notice
             pr
@@ -122,11 +129,49 @@ module Git
           end.compact
         end
 
-        def fetch_merged_pr_numbers_from_github
-          git(:log, '--pretty=format:%H', "origin/#{production_branch}..origin/#{staging_branch}").map(&:chomp).map do |sha1|
-            sleep 1
-            client.search_issues("repo:#{repository} is:pr is:closed #{sha1}")[:items].map(&:number)
-          end.flatten
+        def search_issue_numbers(query)
+          sleep 1
+          say "search issues with query:#{query}", :debug
+          # Fortunately, we don't need to take care of the page count in response, because
+          # the default value of per_page is 30 and we can't specify more than 30 commits due to
+          # the length limit specification of the query string.
+          client.search_issues("#{query}")[:items].map(&:number)
+        end
+
+        def fetch_squash_merged_pr_numbers_from_github
+          # When "--abbrev" is specified, the length of the each line of the stdout isn't fixed.
+          # It is just a minimum length, and if the commit cannot be uniquely identified with
+          # that length, a longer commit hash will be displayed.
+          # We specify this option to minimize the length of the query string, but we use
+          # "--abbrev=7" because the SHA syntax of the search API requires a string of at
+          # least 7 characters.
+          # ref. https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests#search-by-commit-sha
+          # This is done because there is a length limit on the API query string, and we want
+          # to create a string with the minimum possible length.
+          shas = git(:log, '--pretty=format:%h', "--abbrev=7", "--no-merges", "--first-parent",
+            "origin/#{production_branch}..origin/#{staging_branch}").map(&:chomp)
+
+          pr_nums = []
+          query_base = "repo:#{repository} is:pr is:closed"
+          query = query_base
+          # Make bulk requests with multiple SHAs of the maximum possible length.
+          # If multiple SHAs are specified, the issue search API will treat it like an OR search,
+          # and all the pull requests will be searched.
+          # This is difficult to read from the current documentation, but that is the current
+          # behavior and GitHub support has responded that this is the spec.
+          shas.each do |sha|
+            # Longer than 256 characters are not supported in the query.
+            # ref. https://docs.github.com/en/rest/reference/search#limitations-on-query-length
+            if query.length + 1 + sha.length >= 256
+              pr_nums.concat(search_issue_numbers(query))
+              query = query_base
+            end
+            query += " " + sha
+          end
+          if query != query_base
+              pr_nums.concat(search_issue_numbers(query))
+          end
+          pr_nums
         end
 
         def create_release_pr(merged_prs)
@@ -176,7 +221,7 @@ module Git
 
         def build_and_merge_pr_title_and_body(release_pr, merged_prs, changed_files)
           # release_pr is nil when dry_run && create_mode
-          old_body = release_pr ? release_pr.body : ""
+          old_body = (release_pr && release_pr.body != nil) ? release_pr.body : ""
           pr_title, new_body = build_pr_title_and_body(release_pr, merged_prs, changed_files, template_path)
 
           [pr_title, merge_pr_body(old_body, new_body)]

data/lib/git/pr/release/pull_request.rb

@@ -10,8 +10,12 @@ module Git
           @pr = pr
         end
 
-        def to_checklist_item
-          "- [ ] ##{pr.number}" + mention
+        def to_checklist_item(print_title = false)
+          if print_title
+            "- [ ] ##{pr.number} #{pr.title}" + mention
+          else
+            "- [ ] ##{pr.number}" + mention
+          end
         end
 
         def html_link

data/spec/git/pr/release/cli_spec.rb

@@ -36,8 +36,8 @@ RSpec.describe Git::Pr::Release::CLI do
           conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
           conn.adapter(:test, Faraday::Adapter::Test::Stubs.new)
         end
-        pr_3 = Sawyer::Resource.new(agent, YAML.load_file(file_fixture("pr_3.yml")))
-        pr_4 = Sawyer::Resource.new(agent, YAML.load_file(file_fixture("pr_4.yml")))
+        pr_3 = Sawyer::Resource.new(agent, load_yaml("pr_3.yml"))
+        pr_4 = Sawyer::Resource.new(agent, load_yaml("pr_4.yml"))
         [pr_3, pr_4]
       }
       it {
@@ -219,8 +219,8 @@ RSpec.describe Git::Pr::Release::CLI do
       }
 
       client = double(Octokit::Client)
-      @pr_3 = Sawyer::Resource.new(agent, YAML.load_file(file_fixture("pr_3.yml")))
-      @pr_4 = Sawyer::Resource.new(agent, YAML.load_file(file_fixture("pr_4.yml")))
+      @pr_3 = Sawyer::Resource.new(agent, load_yaml("pr_3.yml"))
+      @pr_4 = Sawyer::Resource.new(agent, load_yaml("pr_4.yml"))
       expect(client).to receive(:pull_request).with("motemen/git-pr-release", 3) { @pr_3 }
       expect(client).to receive(:pull_request).with("motemen/git-pr-release", 4) { @pr_4 }
       allow(@cli).to receive(:client).with(no_args) { client }
@@ -241,8 +241,8 @@ RSpec.describe Git::Pr::Release::CLI do
       end
 
       @merged_prs = [
-        Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_3.yml"))),
-        Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_4.yml"))),
+        Sawyer::Resource.new(@agent, load_yaml("pr_3.yml")),
+        Sawyer::Resource.new(@agent, load_yaml("pr_4.yml")),
       ]
 
       allow(@cli).to receive(:detect_existing_release_pr) { existing_release_pr }
@@ -261,7 +261,7 @@ RSpec.describe Git::Pr::Release::CLI do
 
     context "When create_mode" do
       before {
-        @created_pr = Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_1.yml")))
+        @created_pr = Sawyer::Resource.new(@agent, load_yaml("pr_1.yml"))
         allow(@cli).to receive(:prepare_release_pr) { @created_pr }
       }
 
@@ -301,7 +301,7 @@ RSpec.describe Git::Pr::Release::CLI do
 
     context "When dry_run with create_mode" do
       before {
-        @created_pr = Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_1.yml")))
+        @created_pr = Sawyer::Resource.new(@agent, load_yaml("pr_1.yml"))
         allow(@cli).to receive(:prepare_release_pr) { @created_pr }
 
         @cli.instance_variable_set(:@dry_run, true)

data/spec/git/pr/release_spec.rb

@@ -8,13 +8,13 @@ RSpec.describe Git::Pr::Release do
       conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
       conn.adapter :test, @stubs
     end
-    @release_pr = Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_1.yml")))
+    @release_pr = Sawyer::Resource.new(@agent, load_yaml("pr_1.yml"))
     @merged_prs = [
-      Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_3.yml"))),
-      Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_6.yml"))),
+      Sawyer::Resource.new(@agent, load_yaml("pr_3.yml")),
+      Sawyer::Resource.new(@agent, load_yaml("pr_6.yml")),
     ]
     @changed_files = [
-      Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_1_files.yml"))),
+      Sawyer::Resource.new(@agent, load_yaml("pr_1_files.yml")),
     ]
   end
 
@@ -24,8 +24,8 @@ RSpec.describe Git::Pr::Release do
         pr_title, new_body = build_pr_title_and_body(@release_pr, @merged_prs, @changed_files, nil)
         expect(pr_title).to eq "Release 2019-02-20 22:58:35 +0900"
         expect(new_body).to eq <<~MARKDOWN
-          - [ ] #3 Provides a creating release pull-request object for template @hakobe
-          - [ ] #6 Support two factor auth @ninjinkun
+          - [ ] #3 @hakobe
+          - [ ] #6 @ninjinkun
         MARKDOWN
       }
     end

data/spec/support/file_fixture_support.rb

@@ -1,4 +1,12 @@
 module FileFixtureSupport
+  def load_yaml(fixture_name)
+    if YAML.respond_to?(:unsafe_load_file)
+      YAML.unsafe_load_file(file_fixture(fixture_name))
+    else
+      YAML.load_file(file_fixture(fixture_name))
+    end
+  end
+
   def file_fixture(fixture_name)
     file_fixture_path = RSpec.configuration.file_fixture_path
     path = Pathname.new(File.join(file_fixture_path, fixture_name))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-pr-release
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.1.0
 platform: ruby
 authors:
 - motemen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -117,6 +117,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -162,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: Creates a release pull request