Class: Fastlane::Actions::GithubListIssuesAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



199
200
201
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 199

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
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
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 101

def available_options
  [
    FastlaneCore::ConfigItem.new(key: :api_token,
                            env_name: "GITHUB_API_TOKEN",
                         description: "GitHub API token with repo permissions",
                            optional: false,
                                type: String,
                           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: "Repository owner (organization or username)",
                            optional: false,
                                type: String,
                       verify_block: proc do |value|
                          UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if value.to_s.empty?
                        end),
    FastlaneCore::ConfigItem.new(key: :repo_name,
                         env_name: "GITHUB_API_REPO_NAME",
                         description: "Repository name",
                            optional: false,
                                type: String,
                       verify_block: proc do |value|
                          UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if value.to_s.empty?
                        end),
    FastlaneCore::ConfigItem.new(key: :state,
                         description: "Issue state (open, closed, all)",
                            optional: true,
                       default_value: "open",
                                type: String),
    FastlaneCore::ConfigItem.new(key: :assignee,
                         description: "GitHub username, or 'none' for unassigned issues",
                            optional: true,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :creator,
                         description: "GitHub username of issue creator",
                            optional: true,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :mentioned,
                         description: "GitHub username that's mentioned in the issue",
                            optional: true,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :labels,
                         description: "Array of label names, comma-separated",
                            optional: true,
                                type: Array),
    FastlaneCore::ConfigItem.new(key: :sort,
                         description: "Sort by (created, updated, comments)",
                            optional: true,
                       default_value: "created",
                                type: String),
    FastlaneCore::ConfigItem.new(key: :direction,
                         description: "Sort direction (asc or desc)",
                            optional: true,
                       default_value: "desc",
                                type: String),
    FastlaneCore::ConfigItem.new(key: :since,
                         description: "Only issues updated after this ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ)",
                            optional: true,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :per_page,
                         description: "Results per page (max 100)",
                            optional: true,
                       default_value: 30,
                                type: Integer),
    FastlaneCore::ConfigItem.new(key: :page,
                         description: "Page number of the results",
                            optional: true,
                       default_value: 1,
                                type: Integer),
    FastlaneCore::ConfigItem.new(key: :milestone,
                         description: "Milestone number, 'none' for issues with no milestone, or '*' for issues with any milestone",
                            optional: true,
                                type: String)
  ]
end

.category ⇒ Object 



226
227
228
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 226

def category
  :source_control
end

.description ⇒ Object 



89
90
91
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 89

def description
  "Lists issues in a GitHub repository"
end

.details ⇒ Object 



93
94
95
96
97
98
99
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 93

def details
  [
    "This action fetches a list of issues from a GitHub repository with various filtering options.",
    "It requires a valid GitHub API token with appropriate permissions.",
    "Documentation: [https://docs.github.com/en/rest/issues/issues](https://docs.github.com/en/rest/issues/issues#list-repository-issues)"
  ].join("\n")
end

.example_code ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 203

def example_code
  [
    'github_list_issues(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      state: "open",
      sort: "created",
      direction: "desc"
    )',
    '# You can also access the response data
    result = github_list_issues(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      labels: ["bug", "critical"]
    )
    result[:json].each do |issue|
      UI.message("Issue ##{issue["number"]}: #{issue["title"]}")
    end'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 230

def is_supported?(platform)
  true
end

.output ⇒ Object 



187
188
189
190
191
192
193
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 187

def output
  [
    ['GITHUB_LIST_ISSUES_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_LIST_ISSUES_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_LIST_ISSUES_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



195
196
197
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 195

def return_value
  "A hash including the HTTP status code (:status), the response body (:body), and the parsed JSON (:json)."
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
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_issues_action.rb', line 14

def run(params)
  token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  server_url = params[:server_url]
  
  # Validate parameters (additional validation beyond what's in ConfigItem)
  UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if repo_owner.to_s.empty?
  UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if repo_name.to_s.empty?
  
  # Prepare request parameters
  path = "/repos/#{repo_owner}/#{repo_name}/issues"
  
  # Build query parameters
  query_params = {}
  query_params[:state] = params[:state] if params[:state]
  query_params[:assignee] = params[:assignee] if params[:assignee]
  query_params[:creator] = params[:creator] if params[:creator]
  query_params[:mentioned] = params[:mentioned] if params[:mentioned]
  query_params[:labels] = params[:labels].join(',') if params[:labels]
  query_params[:sort] = params[:sort] if params[:sort]
  query_params[:direction] = params[:direction] if params[:direction]
  query_params[:since] = params[:since] if params[:since]
  query_params[:per_page] = params[:per_page] if params[:per_page]
  query_params[:page] = params[:page] if params[:page]
  query_params[:milestone] = params[:milestone] if params[:milestone]
  
  # Make the request
  UI.message("Fetching issues for #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: token,
    path: path,
    params: query_params,
    method: :get,
    server_url: server_url
  )
  
  status_code = response.key?('status') ? response['status'] : nil
  result = {
    status: status_code,
    body: response,
    json: response
  }
  
  if response.key?('error')
    UI.error("GitHub responded with an error: #{response['error']}")
    UI.user_error!("GitHub API error: #{response['error']}")
    return nil
  end
  
  if response.is_a?(Hash) && response['message'] && status_code && status_code >= 400
    UI.error("GitHub API error: #{response['message']}")
    UI.user_error!("GitHub API error: #{response['message']} (Status code: #{status_code})")
    return nil
  end
  
  # Print issue count
  if response.is_a?(Array)
    UI.success("Successfully fetched #{response.count} issues from #{repo_owner}/#{repo_name}")
  else
    UI.success("Successfully fetched issues from #{repo_owner}/#{repo_name}")
  end
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_LIST_ISSUES_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_LIST_ISSUES_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_LIST_ISSUES_JSON] = response
  
  return result
end