Class: Fastlane::Actions::GithubGetIssueTimelineAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



164
165
166
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 164

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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

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: :issue_number,
                         env_name: "GITHUB_API_ISSUE_NUMBER",
                         description: "The issue number",
                            optional: false,
                                type: Integer),
    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)
  ]
end

.category ⇒ Object 



189
190
191
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 189

def category
  :source_control
end

.description ⇒ Object 



86
87
88
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 86

def description
  "Gets the timeline of events for a GitHub issue"
end

.details ⇒ Object 



90
91
92
93
94
95
96
97
98
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 90

def details
  [
    "This action fetches the timeline of events for a specific issue in a GitHub repository.",
    "The timeline includes a variety of events beyond basic issue events, such as cross-references, " +
    "assigned events, labeled events, and more.",
    "It requires a valid GitHub API token with appropriate permissions.",
    "Documentation: [https://docs.github.com/en/rest/issues/timeline](https://docs.github.com/en/rest/issues/timeline#list-timeline-events-for-an-issue)"
  ].join("\n")
end

.example_code ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 168

def example_code
  [
    'github_get_issue_timeline(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      issue_number: 123
    )',
    '# You can also access the response data
    result = github_get_issue_timeline(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      issue_number: 123
    )
    result[:json].each do |event|
      UI.message("Event: #{event["event_type"] || event["event"]}")
    end'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 193

def is_supported?(platform)
  true
end

.output ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 152

def output
  [
    ['GITHUB_GET_ISSUE_TIMELINE_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_GET_ISSUE_TIMELINE_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_GET_ISSUE_TIMELINE_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



160
161
162
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_timeline_action.rb', line 160

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

def run(params)
  token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  issue_number = params[:issue_number]
  server_url = params[:server_url]
  
  # Validate parameters (additional validation beyond what's in ConfigItem)
  UI.user_error!("No GitHub issue number given, pass using `issue_number: 123`") unless issue_number.to_s.length > 0
  
  # Prepare request parameters
  path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/timeline"
  
  # Build query parameters
  query_params = {}
  query_params[:per_page] = params[:per_page] if params[:per_page]
  query_params[:page] = params[:page] if params[:page]
  
  # Custom header required for timeline API
  headers = {
    'Accept' => 'application/vnd.github.mockingbird-preview+json'
  }
  
  # Make the request
  UI.message("Fetching timeline for issue ##{issue_number} in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: token,
    path: path,
    params: query_params,
    method: :get,
    server_url: server_url,
    headers: headers
  )
  
  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 timeline events count
  if response.is_a?(Array)
    UI.success("Successfully fetched #{response.count} timeline events for issue ##{issue_number}")
  else
    UI.success("Successfully fetched timeline for issue ##{issue_number}")
  end
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_TIMELINE_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_TIMELINE_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_TIMELINE_JSON] = response
  
  return result
end