Class: Fastlane::Actions::GithubUpdateIssueCommentAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



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

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
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_issue_comment_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: "Repository owner (organization or username)",
                         optional: false,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :repo_name,
                         env_name: "GITHUB_API_REPO_NAME",
                      description: "Repository name",
                         optional: false,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :comment_id,
                      description: "The ID of the comment to update",
                         optional: false,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :body,
                      description: "The updated body text of the comment",
                         optional: false,
                             type: String)
  ]
end

.category ⇒ Object 



162
163
164
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_issue_comment_action.rb', line 162

def category
  :source_control
end

.description ⇒ Object 



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

def description
  "Updates a comment on a GitHub issue"
end

.details ⇒ Object 



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

def details
  [
    "Updates an existing comment on an issue in a GitHub repository.",
    "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
    "API Documentation: https://docs.github.com/en/rest/issues/comments#update-an-issue-comment"
  ].join("\n")
end

.example_code ⇒ Object 



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_update_issue_comment_action.rb', line 141

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

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


166
167
168
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_issue_comment_action.rb', line 166

def is_supported?(platform)
  true
end

.output ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_issue_comment_action.rb', line 125

def output
  [
    ['GITHUB_UPDATE_ISSUE_COMMENT_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_UPDATE_ISSUE_COMMENT_RESPONSE', 'The full response body from the GitHub API'],
    ['GITHUB_UPDATE_ISSUE_COMMENT_JSON', 'The parsed JSON returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



133
134
135
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_issue_comment_action.rb', line 133

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_update_issue_comment_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]
  comment_id = params[:comment_id]
  body = params[:body]
  
  # Validate parameters
  UI.user_error!("No comment ID provided, pass using `comment_id: 12345678`") unless comment_id.to_s.length > 0
  UI.user_error!("No comment body provided, pass using `body: 'Updated comment'`") if body.to_s.empty?
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/issues/comments/#{comment_id}"
  
  # Build body parameters
  body_params = {
    body: body
  }
  
  UI.message("Updating comment ID: #{comment_id} in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: body_params,
    method: :patch,
    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)
    UI.success("Successfully updated comment ID: #{comment_id} in #{repo_owner}/#{repo_name}")
  else
    UI.error("Error updating comment: #{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_UPDATE_ISSUE_COMMENT_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_UPDATE_ISSUE_COMMENT_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_UPDATE_ISSUE_COMMENT_JSON] = json_response
  
  return result
end