git-pr-release 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c0778ca6554a01e7e89cce4025f866f4e21a648e64250867ce0cdb0b0543707
-  data.tar.gz: 0a9482b016bb56b29b8ba110f2009308ad802b28b20681c184b7b0b3f887636d
+  metadata.gz: 10a02af243f4da16852984b6f131d360f2f815f1706ee3f1cc46a568827f86f1
+  data.tar.gz: 42df34c42101d8f15fedeeafe9b06e27adedfa90d88033b72b5644748d163dca
 SHA512:
-  metadata.gz: 83746e8bc0a21c2ca40192de1d4ff5978b1aacf394734f4526a4569b1f97e45273b8a81f3acdb6a4571b6d9470fba06ccffb9c2245117c1c345fa47a60ebb71c
-  data.tar.gz: 4c077a19a308744d8e2a293a7e5eacd11e1677e1635de9efafc43675820c7413e2f518e44c17782a04d61684ca305f174bfffa4d5febc2320a278b63f4713b49
+  metadata.gz: ab9372594976f0953e8dc7520453c8108cb304d5a0570b2d20e6c7c0a5614bb34db41e5ce25a975ae58ea18b5f2d6be04aa933c0a21d630ae0e4348119661d3a
+  data.tar.gz: 7b57ebdd687de251b86d9e496e5f2f860ec99b6375c0167154e62dde26624f7932612c18b9da39f990f18b845fa0f96f496e7f338dd4e2d818d2bdb046a9dc68

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 3
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 3

data/.github/workflows/release.yml

@@ -12,13 +12,13 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
 
-      - uses: ruby/setup-ruby@ac793fdd38cc468a4dd57246fa9d0e868aba9085 # v1.270.0
+      - uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           bundler-cache: true
           ruby-version: ruby
 
-      - uses: rubygems/release-gem@1c162a739e8b4cb21a676e97b087e8268d8fc40b # v1.1.2
+      - uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1

data/.github/workflows/test.yml

@@ -15,34 +15,25 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - "3.0"
           - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
+          - "4.0"
           - head
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: Cache vendor/bundle
-        uses: actions/cache@v4
-        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
+        run: bundle update --jobs $(nproc) --retry 3
         continue-on-error: ${{ matrix.allow_failures == 'true' }}
-      - name: Run ${{ matrix.test_framework }}
-        run: |
-          set -xe
-          bundle exec rspec
+      - name: Run RSpec
+        run: bundle exec rspec
         continue-on-error: ${{ matrix.allow_failures == 'true' }}

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # git-pr-release
 
+## v2.6.0 (2026-09-09)
+
+[full changelog](https://github.com/x-motemen/git-pr-release/compare/v2.5.0...v2.6.0)
+
+* (#123) Retry GitHub API requests failing with a server error (@exoego)
+
 ## v2.5.0 (2025-12-16)
 
 [full changelog](https://github.com/x-motemen/git-pr-release/compare/v2.4.0...v2.5.0)

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.5.0'
+  spec.version       = '2.6.0'
   spec.authors       = ["motemen"]
   spec.email         = ["motemen@gmail.com"]
   spec.summary       = 'Creates a release pull request'
@@ -17,7 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 3.0'
+
   spec.add_dependency 'octokit'
+  spec.add_dependency 'faraday-retry'
   spec.add_dependency 'highline'
   spec.add_dependency 'colorize'
   spec.add_dependency 'diff-lcs'

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

@@ -1,3 +1,4 @@
+require 'faraday/retry'
 require 'octokit'
 require 'optparse'
 
@@ -54,8 +55,23 @@ module Git
           return 0
         end
 
+        # POST is left out: retrying it could create a duplicated release pull request.
+        RETRY_OPTIONS = {
+          max: 5,
+          interval: 1,
+          interval_randomness: 0.5,
+          backoff_factor: 2,
+          retry_statuses: [500, 502, 503, 504],
+          methods: %i[delete get head options patch put]
+        }.freeze
+
         def client
-          @client ||= Octokit::Client.new :access_token => obtain_token!
+          @client ||= Octokit::Client.new(:access_token => obtain_token!).tap do |client|
+            # Inside RaiseError so retry_statuses sees the response, not Octokit::ServerError.
+            client.middleware = client.middleware.dup.tap do |builder|
+              builder.insert_after Octokit::Response::RaiseError, Faraday::Retry::Middleware, RETRY_OPTIONS
+            end
+          end
         end
 
         def configure
@@ -175,9 +191,13 @@ module Git
           # 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.
+            # GitHub documents a 256-character limit for search queries, but in practice
+            # the API enforces a stricter limit, likely due to URL-encoded length counting.
+            # Multiple users have reported errors at 220-240 characters, with 200 being stable.
             # ref. https://docs.github.com/en/rest/reference/search#limitations-on-query-length
-            if query.length + 1 + sha.length >= 256
+            # ref. https://github.com/x-motemen/git-pr-release/issues/103
+            # ref. https://github.com/orgs/community/discussions/186957
+            if query.length + 1 + sha.length >= 200
               pr_nums.concat(search_issue_numbers(query))
               query = query_base
             end

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

@@ -313,6 +313,64 @@ RSpec.describe Git::Pr::Release::CLI do
     end
   end
 
+  describe "#client" do
+    subject { @cli.client }
+
+    let(:pull_request_url) { "https://api.github.com/repos/motemen/git-pr-release/pulls/1023" }
+
+    before {
+      @cli = configured_cli
+
+      allow(@cli).to receive(:obtain_token!) { "dummy token" }
+    }
+
+    context "When the GitHub API responds a server error to an idempotent request" do
+      before {
+        stub_request(:patch, pull_request_url).to_return(
+          { status: 502, body: "", headers: {} },
+          { status: 200, body: %({"number":1023}), headers: { "Content-Type" => "application/json" } },
+        )
+      }
+
+      it "retries the request" do
+        expect(subject.update_pull_request("motemen/git-pr-release", 1023, title: "PR Title").number).to eq 1023
+        expect(a_request(:patch, pull_request_url)).to have_been_made.twice
+      end
+    end
+
+    context "When the GitHub API responds a server error to a request creating a pull request" do
+      let(:pull_requests_url) { "https://api.github.com/repos/motemen/git-pr-release/pulls" }
+
+      before {
+        stub_request(:post, pull_requests_url).to_return(status: 502, body: "", headers: {})
+      }
+
+      it "does not retry the request" do
+        expect {
+          subject.create_pull_request("motemen/git-pr-release", "master", "staging", "PR Title", "")
+        }.to raise_error Octokit::BadGateway
+        expect(a_request(:post, pull_requests_url)).to have_been_made.once
+      end
+    end
+
+    context "When the GitHub API responds a client error" do
+      before {
+        stub_request(:patch, pull_request_url).to_return(status: 404, body: "", headers: {})
+      }
+
+      it "does not retry the request" do
+        expect {
+          subject.update_pull_request("motemen/git-pr-release", 1023, title: "PR Title")
+        }.to raise_error Octokit::NotFound
+        expect(a_request(:patch, pull_request_url)).to have_been_made.once
+      end
+    end
+
+    it "does not modify the middleware shared by every Octokit client" do
+      expect { subject }.not_to change { Octokit::Default::MIDDLEWARE.handlers }
+    end
+  end
+
   describe "#fetch_merged_prs" do
     subject { @cli.fetch_merged_prs }
 
@@ -707,4 +765,64 @@ RSpec.describe Git::Pr::Release::CLI do
       expect(@client).to have_received(:auto_paginate=).with(false)
     }
   end
+
+  describe "#fetch_squash_merged_pr_numbers_from_github" do
+    subject { @cli.send(:fetch_squash_merged_pr_numbers_from_github) }
+
+    before {
+      @cli = configured_cli
+
+      allow(@cli).to receive(:git).with(:log, '--pretty=format:%h', "--abbrev=7", "--no-merges", "--first-parent",
+        "origin/master..origin/staging") { shas.map { |sha| "#{sha}\n" } }
+      allow(@cli).to receive(:search_issue_numbers) { |query| [123] }
+    }
+
+    context "When SHAs fit within query length limit" do
+      let(:shas) { ["abc1234", "def5678"] }
+
+      it "makes a single search request" do
+        subject
+
+        expect(@cli).to have_received(:search_issue_numbers).once
+      end
+    end
+
+    context "When SHAs exceed query length limit" do
+      # query_base = "repo:motemen/git-pr-release is:pr is:closed" (44 characters)
+      # Each SHA is 7 characters + 1 space = 8 characters
+      # Available space for SHAs: 200 - 44 = 156 characters
+      # To exceed the limit: 156 / 8 = ~19.5, so 20 SHAs will trigger a split
+      let(:shas) { (1..25).map { |i| sprintf("%07d", i) } }
+
+      it "splits into multiple search requests" do
+        subject
+
+        expect(@cli).to have_received(:search_issue_numbers).at_least(2).times
+      end
+
+      it "keeps total query length under 200 characters" do
+        call_count = 0
+
+        allow(@cli).to receive(:search_issue_numbers) do |query|
+          call_count += 1
+          expect(query.length).to be < 200
+          [123]
+        end
+
+        subject
+
+        expect(call_count).to be > 1
+      end
+    end
+
+    context "When query_base is empty after processing all SHAs" do
+      let(:shas) { ["abc1234"] }
+
+      it "makes exactly one search request" do
+        subject
+
+        expect(@cli).to have_received(:search_issue_numbers).once
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-pr-release
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - motemen
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  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: highline
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -171,14 +186,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Creates a release pull request
 test_files: