Class: Fastlane::Actions::GithubGetIssueCommentAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



140
141
142
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_comment_action.rb', line 140

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

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: :comment_id,
                         description: "The ID of the comment to fetch",
                            optional: false,
                                type: Integer)
  ]
end

.category ⇒ Object 



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

def category
  :source_control
end

.description ⇒ Object 



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

def description
  "Gets a specific comment from a GitHub issue"
end

.details ⇒ Object 



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

def details
  [
    "This action fetches a specific comment from a GitHub issue by its comment ID.",
    "It requires a valid GitHub API token with appropriate permissions.",
    "Documentation: [https://docs.github.com/en/rest/issues/comments](https://docs.github.com/en/rest/issues/comments#get-an-issue-comment)"
  ].join("\n")
end

.example_code ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_comment_action.rb', line 144

def example_code
  [
    'github_get_issue_comment(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      comment_id: 12345678
    )',
    '# You can also access the response data
    result = github_get_issue_comment(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      comment_id: 12345678
    )
    UI.message("Comment by: #{result[:json]["user"]["login"]}")
    UI.message("Comment body: #{result[:json]["body"]}")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_comment_action.rb', line 168

def is_supported?(platform)
  true
end

.output ⇒ Object 



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

def output
  [
    ['GITHUB_GET_ISSUE_COMMENT_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_GET_ISSUE_COMMENT_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_GET_ISSUE_COMMENT_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



136
137
138
 
# File 'lib/fastlane/plugin/github_api/actions/github_get_issue_comment_action.rb', line 136

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

def run(params)
  token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  comment_id = params[:comment_id]
  server_url = params[:server_url]
  
  # Validate parameters (additional validation beyond what's in ConfigItem)
  UI.user_error!("No comment ID provided, pass using `comment_id: 12345678`") unless comment_id.to_s.length > 0
  
  # Prepare request parameters
  path = "/repos/#{repo_owner}/#{repo_name}/issues/comments/#{comment_id}"
  
  # Make the request
  UI.message("Fetching comment ID #{comment_id} from #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: token,
    path: path,
    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['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 comment user info
  if response['user'] && response['user']['login']
    user = response['user']['login']
    UI.success("Successfully fetched comment ID #{comment_id} by #{user}")
  else
    UI.success("Successfully fetched comment ID #{comment_id}")
  end
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_COMMENT_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_COMMENT_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_COMMENT_JSON] = response
  
  return result
end