Class: Fastlane::Actions::GithubRequestPullReviewAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



141
142
143
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_pull_review_action.rb', line 141

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
119
120
121
122
123
124
125
126
127
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_pull_review_action.rb', line 86

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: :reviewers,
                         env_name: "GITHUB_API_PULL_REVIEWERS",
                      description: "An array of user logins that will be requested to review",
                         optional: true,
                             type: Array),
    FastlaneCore::ConfigItem.new(key: :team_reviewers,
                         env_name: "GITHUB_API_PULL_TEAM_REVIEWERS",
                      description: "An array of team slugs that will be requested to review",
                         optional: true,
                             type: Array)
  ]
end

.description ⇒ Object 



74
75
76
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_pull_review_action.rb', line 74

def description
  "Requests reviewers for a pull request"
end

.details ⇒ Object 



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

def details
  [
    "Requests reviewers 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/review-requests#request-reviewers-for-a-pull-request"
  ].join("\n")
end

.example_code ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_pull_review_action.rb', line 149

def example_code
  [
    'github_request_pull_review(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      reviewers: ["username1", "username2"]
    )',
    'github_request_pull_review(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      reviewers: ["username1"],
      team_reviewers: ["engineering-team"]
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_pull_review_action.rb', line 145

def is_supported?(platform)
  true
end

.output ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_pull_review_action.rb', line 129

def output
  [
    ['GITHUB_REQUEST_PULL_REVIEW_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_REQUEST_PULL_REVIEW_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_REQUEST_PULL_REVIEW_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



137
138
139
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_pull_review_action.rb', line 137

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
 
# File 'lib/fastlane/plugin/github_api/actions/github_request_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]
  reviewers = params[:reviewers]
  team_reviewers = params[:team_reviewers]
  
  # Build the body for the request
  body = {}
  body[:reviewers] = reviewers if reviewers && !reviewers.empty?
  body[:team_reviewers] = team_reviewers if team_reviewers && !team_reviewers.empty?
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/requested_reviewers"
  
  UI.message("Requesting reviewers for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: 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)
    reviewer_count = reviewers ? reviewers.count : 0
    team_count = team_reviewers ? team_reviewers.count : 0
    UI.success("Successfully requested #{reviewer_count} reviewers and #{team_count} team reviewers for pull request ##{pull_number}")
  else
    UI.error("Error requesting reviewers: #{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_REQUEST_PULL_REVIEW_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_REQUEST_PULL_REVIEW_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_REQUEST_PULL_REVIEW_JSON] = json_response
  
  return result
end