Class: Fastlane::Actions::GithubUpdatePullBranchAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



132
133
134
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 132

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 82

def available_options
  [
    FastlaneCore::ConfigItem.new(key: :api_token,
                         env_name: "GITHUB_API_TOKEN",
                      description: "GitHub API token",
                         optional: false,
                        sensitive: true,
               code_gen_sensitive: true,
                    default_value: ENV["GITHUB_API_TOKEN"],
                     verify_block: proc do |value|
                       UI.user_error!("No GitHub API token given, pass using `api_token: 'token'`") if value.to_s.empty?
                     end),
    FastlaneCore::ConfigItem.new(key: :server_url,
                         env_name: "GITHUB_API_SERVER_URL",
                      description: "GitHub API server URL",
                         optional: true,
                    default_value: "https://api.github.com"),
    FastlaneCore::ConfigItem.new(key: :repo_owner,
                         env_name: "GITHUB_API_REPO_OWNER",
                      description: "Owner of the repository",
                         optional: false),
    FastlaneCore::ConfigItem.new(key: :repo_name,
                         env_name: "GITHUB_API_REPO_NAME",
                      description: "Name of the repository",
                         optional: false),
    FastlaneCore::ConfigItem.new(key: :pull_number,
                         env_name: "GITHUB_API_PULL_NUMBER",
                      description: "The number of the pull request",
                         optional: false,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :expected_head_sha,
                         env_name: "GITHUB_API_EXPECTED_HEAD_SHA",
                      description: "The expected SHA of the pull request's HEAD ref",
                         optional: true,
                             type: String)
  ]
end

.description ⇒ Object 



70
71
72
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 70

def description
  "Updates a pull request branch with the latest upstream changes"
end

.details ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 74

def details
  [
    "Updates the pull request branch with the latest upstream changes by merging head from the base branch.",
    "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
    "API Documentation: https://docs.github.com/en/rest/pulls/pulls#update-a-pull-request-branch"
  ].join("\n")
end

.example_code ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 140

def example_code
  [
    'github_update_pull_branch(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42
    )',
    'github_update_pull_branch(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      expected_head_sha: "6dcb09b5b57875f334f61aebed695e2e4193db5e"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



136
137
138
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 136

def is_supported?(platform)
  true
end

.output ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 120

def output
  [
    ['GITHUB_UPDATE_PULL_BRANCH_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_UPDATE_PULL_BRANCH_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_UPDATE_PULL_BRANCH_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



128
129
130
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 128

def return_value
  "Returns a hash containing the status code, response body, and parsed JSON response from the GitHub API."
end

.run(params) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_branch_action.rb', line 14

def run(params)
  require 'json'
  
  # Prepare API call parameters
  server_url = params[:server_url]
  api_token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  pull_number = params[:pull_number]
  expected_head_sha = params[:expected_head_sha]
  
  # Build the body for the update request
  body = {}
  body[:expected_head_sha] = expected_head_sha if expected_head_sha
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/update-branch"
  
  UI.message("Updating branch for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: body,
    method: :put,
    server_url: server_url
  )
  
  status_code = response[:status]
  json_response = response[:json]
  result = {
    status: status_code,
    body: response[:body],
    json: json_response
  }
  
  if status_code.between?(200, 299)
    UI.success("Successfully updated branch for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
  else
    UI.error("Error updating branch for pull request: #{status_code}")
    UI.error(response[:body])
    UI.user_error!("GitHub API returned #{status_code}: #{response[:body]}")
    return nil
  end
  
  # Store the results in shared values
  Actions.lane_context[SharedValues::GITHUB_UPDATE_PULL_BRANCH_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_UPDATE_PULL_BRANCH_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_UPDATE_PULL_BRANCH_JSON] = json_response
  
  return result
end