Class: Fastlane::Actions::GithubSubmitPullReviewAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



151
152
153
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 151

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 87

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: :event,
                         env_name: "GITHUB_API_REVIEW_EVENT",
                      description: "The review action (APPROVE, REQUEST_CHANGES, COMMENT)",
                         optional: true,
                             type: String,
                    default_value: "COMMENT",
                     verify_block: proc do |value|
                       UI.user_error!("Event must be one of: APPROVE, REQUEST_CHANGES, COMMENT") unless ['APPROVE', 'REQUEST_CHANGES', 'COMMENT'].include?(value)
                     end),
    FastlaneCore::ConfigItem.new(key: :body,
                         env_name: "GITHUB_API_REVIEW_BODY",
                      description: "The body text of the review",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :comments,
                         env_name: "GITHUB_API_REVIEW_COMMENTS",
                      description: "Comments to add to the review (array of hashes with path, position, body)",
                         optional: true,
                             type: Array)
  ]
end

.description ⇒ Object 



75
76
77
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 75

def description
  "Create a review for a pull request"
end

.details ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 79

def details
  [
    "Creates a new review for a pull request.",
    "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/reviews#create-a-review-for-a-pull-request"
  ].join("\n")
end

.example_code ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 159

def example_code
  [
    'github_submit_pull_review(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      event: "APPROVE",
      body: "Looks good! 👍"
    )',
    'github_submit_pull_review(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      event: "REQUEST_CHANGES",
      body: "Please fix these issues before merging.",
      comments: [
        {
          path: "file.rb",
          position: 10,
          body: "Consider refactoring this section."
        }
      ]
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 155

def is_supported?(platform)
  true
end

.output ⇒ Object 



139
140
141
142
143
144
145
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 139

def output
  [
    ['GITHUB_SUBMIT_PULL_REVIEW_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_SUBMIT_PULL_REVIEW_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_SUBMIT_PULL_REVIEW_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



147
148
149
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_action.rb', line 147

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
65
66
67
68
69
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_review_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]
  event = params[:event]
  body = params[:body]
  comments = params[:comments]
  
  # Build the body for the request
  request_body = {}
  request_body[:event] = event if event
  request_body[:body] = body if body
  request_body[:comments] = comments if comments && !comments.empty?
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/reviews"
  
  UI.message("Submitting a review for pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
  
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: request_body,
    method: :post,
    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 submitted a #{event} review for pull request ##{pull_number}")
  else
    UI.error("Error submitting review: #{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_SUBMIT_PULL_REVIEW_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_REVIEW_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_REVIEW_JSON] = json_response
  
  return result
end