Class: Fastlane::Actions::GithubListPullsAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



174
175
176
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pulls_action.rb', line 174

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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pulls_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: :state,
                         env_name: "GITHUB_API_PR_STATE",
                      description: "State of the PR: open, closed, or all",
                         optional: true,
                    default_value: "open",
                             type: String,
                     verify_block: proc do |value|
                       UI.user_error!("State must be one of: open, closed, all") unless ["open", "closed", "all"].include?(value)
                     end),
    FastlaneCore::ConfigItem.new(key: :head,
                         env_name: "GITHUB_API_PR_HEAD",
                      description: "Filter by head user or head organization and branch name in the format of user:ref-name or organization:ref-name",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :base,
                         env_name: "GITHUB_API_PR_BASE",
                      description: "Filter by base branch name",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :sort,
                         env_name: "GITHUB_API_PR_SORT",
                      description: "What to sort results by: created, updated, popularity, long-running",
                         optional: true,
                    default_value: "created",
                             type: String,
                     verify_block: proc do |value|
                       UI.user_error!("Sort must be one of: created, updated, popularity, long-running") unless ["created", "updated", "popularity", "long-running"].include?(value)
                     end),
    FastlaneCore::ConfigItem.new(key: :direction,
                         env_name: "GITHUB_API_PR_DIRECTION",
                      description: "The direction of the sort: asc or desc",
                         optional: true,
                    default_value: "desc",
                             type: String,
                     verify_block: proc do |value|
                       UI.user_error!("Direction must be one of: asc, desc") unless ["asc", "desc"].include?(value)
                     end),
    FastlaneCore::ConfigItem.new(key: :per_page,
                         env_name: "GITHUB_API_PR_PER_PAGE",
                      description: "Results per page (max 100)",
                         optional: true,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :page,
                         env_name: "GITHUB_API_PR_PAGE",
                      description: "Page number of the results to fetch",
                         optional: true,
                             type: Integer)
  ]
end

.description ⇒ Object 



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

def description
  "Lists pull requests in a GitHub repository"
end

.details ⇒ Object 



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

def details
  [
    "Lists pull requests in a GitHub repository with filtering options.",
    "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#list-pull-requests"
  ].join("\n")
end

.example_code ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pulls_action.rb', line 182

def example_code
  [
    'github_list_pulls(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      state: "open"
    )',
    'pulls = github_list_pulls(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      base: "main",
      sort: "created",
      direction: "desc",
      per_page: 10
    )
    
    pulls[:json].each do |pull|
      puts "PR ##{pull["number"]}: #{pull["title"]}"
    end'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pulls_action.rb', line 178

def is_supported?(platform)
  true
end

.output ⇒ Object 



162
163
164
165
166
167
168
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pulls_action.rb', line 162

def output
  [
    ['GITHUB_LIST_PULLS_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_LIST_PULLS_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_LIST_PULLS_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



170
171
172
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pulls_action.rb', line 170

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_list_pulls_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]
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls"
  
  # Build query parameters
  query_params = {}
  query_params[:state] = params[:state] if params[:state]
  query_params[:head] = params[:head] if params[:head]
  query_params[:base] = params[:base] if params[:base]
  query_params[:sort] = params[:sort] if params[:sort]
  query_params[:direction] = params[:direction] if params[:direction]
  query_params[:per_page] = params[:per_page] if params[:per_page]
  query_params[:page] = params[:page] if params[:page]
  
  UI.message("Listing pull requests for #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: query_params,
    method: :get,
    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)
    pull_count = json_response.count
    UI.success("Successfully retrieved #{pull_count} pull requests from #{repo_owner}/#{repo_name}")
  else
    UI.error("Error listing pull requests: #{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_LIST_PULLS_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_LIST_PULLS_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_LIST_PULLS_JSON] = json_response
  
  return result
end