Class: Fastlane::Actions::GithubCreatePullReviewAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



157
158
159
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 157

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
138
139
140
141
142
143
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 89

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: :commit_id,
                         env_name: "GITHUB_API_COMMIT_ID",
                      description: "The SHA of the commit that needs a review. Required when using REQUEST_CHANGES or COMMENT for events",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :body,
                         env_name: "GITHUB_API_REVIEW_BODY",
                      description: "Text content of the review",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :event,
                         env_name: "GITHUB_API_REVIEW_EVENT",
                      description: "The review action to perform: APPROVE, REQUEST_CHANGES, or COMMENT",
                         optional: true,
                             type: String,
                     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: :comments,
                         env_name: "GITHUB_API_REVIEW_COMMENTS",
                      description: "An array of comments to make during the review (for line-by-line commenting)",
                         optional: true,
                             type: Array)
  ]
end

.category ⇒ Object 



214
215
216
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 214

def category
  :source_control
end

.description ⇒ Object 



77
78
79
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 77

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

.details ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 81

def details
  [
    "Creates a new review for a specified pull request in a GitHub repository.",
    "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 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 161

def example_code
  [
    'github_create_pull_review(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      pull_number: 123,
      event: "APPROVE",
      body: "LGTM! Great work."
    )',
    '# Create a review with comments on specific lines
    github_create_pull_review(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      pull_number: 123,
      event: "COMMENT",
      body: "Here are some comments on the pull request",
      comments: [
        {
          path: "file.rb",
          position: 10,
          body: "Consider using a more descriptive variable name here"
        },
        {
          path: "another_file.rb",
          position: 5,
          body: "This could be optimized"
        }
      ]
    )',
    '# Request changes in a review
    github_create_pull_review(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      pull_number: 123,
      event: "REQUEST_CHANGES",
      body: "Please make the following changes before this can be approved.",
      commit_id: "abc123def456"
    )',
    '# Access the response data
    result = github_create_pull_review(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      pull_number: 123,
      event: "COMMENT"
    )
    UI.message("Created review ID: #{result[:json]["id"]}")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


218
219
220
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 218

def is_supported?(platform)
  true
end

.output ⇒ Object 



145
146
147
148
149
150
151
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 145

def output
  [
    ['GITHUB_CREATE_PULL_REVIEW_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_CREATE_PULL_REVIEW_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_CREATE_PULL_REVIEW_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



153
154
155
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_review_action.rb', line 153

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
70
71
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_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]
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/reviews"
  
  # Build body parameters
  body_params = {}
  body_params[:commit_id] = params[:commit_id] if params[:commit_id]
  body_params[:body] = params[:body] if params[:body]
  body_params[:event] = params[:event] if params[:event]
  
  # Add comment review if comments parameter is provided
  if params[:comments] && !params[:comments].empty?
    body_params[:comments] = params[:comments]
  end
  
  UI.message("Creating review for pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: body_params,
    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)
    review_id = json_response['id']
    UI.success("Successfully created review #{review_id} for pull request ##{pull_number}")
  else
    UI.error("Error creating pull request 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_CREATE_PULL_REVIEW_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_REVIEW_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_REVIEW_JSON] = json_response
  
  return result
end