Class: Fastlane::Actions::GithubSubmitPullCommentAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



155
156
157
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_comment_action.rb', line 155

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_comment_action.rb', line 90

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 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: :pull_number,
                         env_name: "GITHUB_API_PULL_NUMBER",
                      description: "The number of the pull request",
                         optional: false,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :body,
                         env_name: "GITHUB_API_COMMENT_BODY",
                      description: "The body text of the comment",
                         optional: false,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :commit_id,
                         env_name: "GITHUB_API_COMMIT_ID",
                      description: "The SHA of the commit to comment on",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :path,
                         env_name: "GITHUB_API_FILE_PATH",
                      description: "The relative path to the file to comment on",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :position,
                         env_name: "GITHUB_API_FILE_POSITION",
                      description: "The position in the diff to comment on",
                         optional: true,
                             type: Integer)
  ]
end

.description ⇒ Object 



78
79
80
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_comment_action.rb', line 78

def description
  "Create a review comment on a pull request"
end

.details ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_comment_action.rb', line 82

def details
  [
    "Creates a 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#create-a-review-comment-for-a-pull-request"
  ].join("\n")
end

.example_code ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_comment_action.rb', line 163

def example_code
  [
    'github_submit_pull_comment(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      body: "This is a great improvement!"
    )',
    'github_submit_pull_comment(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      body: "This could be improved",
      commit_id: "6dcb09b5b57875f334f61aebed695e2e4193db5e",
      path: "file.rb",
      position: 10
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_comment_action.rb', line 159

def is_supported?(platform)
  true
end

.output ⇒ Object 



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

def output
  [
    ['GITHUB_SUBMIT_PULL_COMMENT_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_SUBMIT_PULL_COMMENT_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_SUBMIT_PULL_COMMENT_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



151
152
153
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_pull_comment_action.rb', line 151

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
68
69
70
71
72
 
# File 'lib/fastlane/plugin/github_api/actions/github_submit_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]
  pull_number = params[:pull_number]
  body = params[:body]
  commit_id = params[:commit_id]
  path = params[:path]
  position = params[:position]
  
  # Build the body for the request
  request_body = {
    body: body
  }
  
  request_body[:commit_id] = commit_id if commit_id
  request_body[:path] = path if path
  request_body[:position] = position if position
  
  # Build the path
  api_path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/comments"
  
  UI.message("Creating a comment on pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: api_path,
    params: request_body,
    method: :post,
    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 created a comment on pull request ##{pull_number}")
  else
    UI.error("Error creating 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_SUBMIT_PULL_COMMENT_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_COMMENT_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_COMMENT_JSON] = json_response
  
  return result
end