Class: Fastlane::Actions::GithubUpdatePullCommentAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



135
136
137
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_comment_action.rb', line 135

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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

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: :comment_id,
                         env_name: "GITHUB_API_PR_COMMENT_ID",
                      description: "The ID of the comment to update",
                         optional: false,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :body,
                         env_name: "GITHUB_API_PR_COMMENT_BODY",
                      description: "The new text of the comment",
                         optional: false,
                             type: String)
  ]
end

.description ⇒ Object 



73
74
75
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_comment_action.rb', line 73

def description
  "Updates a pull request comment"
end

.details ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_comment_action.rb', line 77

def details
  [
    "Updates the body text of an existing review comment on a pull request.",
    "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/comments#update-a-review-comment-for-a-pull-request"
  ].join("\n")
end

.example_code ⇒ Object 



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_comment_action.rb', line 143

def example_code
  [
    'github_update_pull_comment(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      comment_id: 12345,
      body: "Updated comment with more details about the implementation."
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_comment_action.rb', line 139

def is_supported?(platform)
  true
end

.output ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_comment_action.rb', line 123

def output
  [
    ['GITHUB_UPDATE_PULL_COMMENT_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_UPDATE_PULL_COMMENT_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_UPDATE_PULL_COMMENT_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



131
132
133
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_comment_action.rb', line 131

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
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_pull_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]
  
  # Validate required parameters
  UI.user_error!("Comment body is required") if params[:body].to_s.empty?
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/comments/#{comment_id}"
  
  # Build body parameters
  body_params = {
    body: params[:body]
  }
  
  UI.message("Updating pull request comment #{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 pull request comment #{comment_id}")
  else
    UI.error("Error updating pull request 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_PULL_COMMENT_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_UPDATE_PULL_COMMENT_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_UPDATE_PULL_COMMENT_JSON] = json_response
  
  return result
end