Add api_url ConfigItem to create_release_backmerge_pull_request

Author: iangmaia

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_release_backmerge_pull_request_action.rb

@@ -9,6 +9,7 @@ class CreateReleaseBackmergePullRequestAction < Action
       DEFAULT_BRANCH = 'trunk'
 
       def self.run(params)
+        api_url = params[:api_url]
         token = params[:github_token]
         repository = params[:repository]
         source_branch = params[:source_branch]
@@ -41,6 +42,7 @@ def self.run(params)
           Fastlane::Helper::GitHelper.checkout_and_pull(source_branch)
 
           create_backmerge_pr(
+            api_url: api_url,
             token: token,
             repository: repository,
             title: "Merge #{source_branch} into #{target_branch}",
@@ -76,6 +78,7 @@ def self.determine_target_branches(source_release_version:, default_branch:)
 
       # Creates a backmerge pull request using the `create_pull_request` Fastlane Action.
       #
+      # @param api_url [String] the GitHub API URL to use for creating the pull request
       # @param token [String] the GitHub token for authentication.
       # @param repository [String] the repository where the pull request will be created.
       # @param title [String] the title of the pull request.
@@ -90,7 +93,7 @@ def self.determine_target_branches(source_release_version:, default_branch:)
       #
       # @return [String] The URL of the created Pull Request, or `nil` if no PR was created.
       #
-      def self.create_backmerge_pr(token:, repository:, title:, head_branch:, base_branch:, labels:, milestone:, reviewers:, team_reviewers:, intermediate_branch_created_callback:)
+      def self.create_backmerge_pr(api_url:, token:, repository:, title:, head_branch:, base_branch:, labels:, milestone:, reviewers:, team_reviewers:, intermediate_branch_created_callback:) # rubocop:disable Metrics/ParameterLists
         # Do an early pre-check to see if the PR would be valid, but only if no callback (as a callback might add new commits on intermediate branch)
         if intermediate_branch_created_callback.nil? && !can_merge?(head_branch, into: base_branch)
           UI.error("Nothing to merge from #{head_branch} into #{base_branch}. Skipping PR creation.")
@@ -136,6 +139,7 @@ def self.create_backmerge_pr(token:, repository:, title:, head_branch:, base_bra
         BODY
 
         other_action.create_pull_request(
+          api_url: api_url,
           api_token: token,
           repo: repository,
           title: title,
@@ -192,6 +196,10 @@ def self.details
 
       def self.available_options
         [
+          FastlaneCore::ConfigItem.new(key: :api_url,
+                                       description: 'The GitHub API URL to use for creating the pull request. Primarily used when working with GitHub Enterprise instances.',
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :repository,
                                        env_name: 'GHHELPER_REPOSITORY',
                                        description: 'The remote path of the GH repository on which we work',

spec/create_release_backmerge_pull_request_spec.rb

@@ -41,7 +41,7 @@ def stub_git_release_branches(branches)
     end
   end
 
-  def stub_expected_pull_requests(expected_backmerge_branches:, source_branch:, labels: [], milestone_number: nil, reviewers: nil, team_reviewers: nil, branch_exists_on_remote: false, nothing_to_merge_between: [])
+  def stub_expected_pull_requests(expected_backmerge_branches:, source_branch:, labels: [], milestone_number: nil, reviewers: nil, team_reviewers: nil, branch_exists_on_remote: false, nothing_to_merge_between: [], api_url: nil)
     expected_backmerge_branches.map do |target_branch|
       expected_intermediate_branch = "merge/#{source_branch.gsub('/', '-')}-into-#{target_branch.gsub('/', '-')}"
 
@@ -70,7 +70,8 @@ def stub_expected_pull_requests(expected_backmerge_branches:, source_branch:, la
         labels: labels,
         milestone: milestone_number,
         reviewers: reviewers,
-        team_reviewers: team_reviewers
+        team_reviewers: team_reviewers,
+        api_url: api_url
       ).and_return(mock_pr_url(target_branch))
 
       expected_intermediate_branch
@@ -294,6 +295,31 @@ def stub_expected_pull_requests(expected_backmerge_branches:, source_branch:, la
     end
   end
 
+  context 'when providing an api_url' do
+    it 'creates a backmerge PR using the provided api_url' do
+      stub_git_release_branches([])
+
+      source_branch = 'release/30.6'
+      api_url = 'https://github.company.com/api/v3'
+
+      stub_expected_pull_requests(
+        expected_backmerge_branches: [default_branch],
+        source_branch: source_branch,
+        api_url: api_url
+      )
+
+      result = run_described_fastlane_action(
+        github_token: test_token,
+        repository: test_repo,
+        source_branch: source_branch,
+        default_branch: default_branch,
+        api_url: api_url
+      )
+
+      expect(result).to eq([mock_pr_url(default_branch)])
+    end
+  end
+
   context 'when there is nothing to merge' do
     context 'when no callback is provided' do
       it 'detects it should not create a pull request before even creating the intermediate branch' do