git-pr-release 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8bcbbdbe3dfb5b6783306e29dad9c919d86264ea185742aeb07b91d141ac247
-  data.tar.gz: 1d67e25f3acde325baf9a1103ecc619011486847def7e561aa620f9b0f538c9f
+  metadata.gz: e1a94b83554ecc020acc0a736dcec3d764e416cd0a99ea2b3a1948b9b2a85fb6
+  data.tar.gz: 2d41363fc87ca3d42e21b8bf18348f2ff9ef6f2e4a53237c4292338e62a9e257
 SHA512:
-  metadata.gz: 602b5171e7b0a0160555632b19ff35af9ca7bf9c6d560d4364d8251b661cc205b51f645c15d33db701c623817f5ad31c6e307781178a6103582f35f001b06fb1
-  data.tar.gz: 1fad3d9128cc3d982ceb426045013566967d53df7c25364d8b256562863286384b297bbcf14aa0df4acaa81b945e3c570ddef7559c30dbff2a5fe77a41231141
+  metadata.gz: fbb6731c6b4805a9bf512d727641a8e73bc4bf50261c2e821d1a17beeba359a1c2c2ed234269c7b4e05d3d08378ad225ad84955008c055ad6c7bbbe0993db43f
+  data.tar.gz: ac651dbda5be13ed6fd43db65baee451e5dba97723c79c7eaa7ca44c1214500651a10a93f8e8c911062d772c8ead1726edcb5c06a1bf2c9214ff1380406b827d

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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)

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       = '2.0.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,7 +89,10 @@ 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.uniq.sort.map do |nr|
             pr = client.pull_request repository, nr
@@ -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)

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-pr-release
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - motemen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit