Class: Fastlane::Actions::GithubDeletePullCommentAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



116
117
118
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 116

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 72

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 delete",
                         optional: false,
                             type: Integer)
  ]
end

.description ⇒ Object 



60
61
62
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 60

def description
  "Deletes a pull request comment"
end

.details ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 64

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

.example_code ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 124

def example_code
  [
    'github_delete_pull_comment(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      comment_id: 12345
    )',
    'result = github_delete_pull_comment(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      comment_id: 12345
    )
    if result[:status] == 204
      UI.message("Comment successfully deleted")
    end'
  ]
end

.is_supported?(platform) ⇒ Boolean 



120
121
122
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 120

def is_supported?(platform)
  true
end

.output ⇒ Object 



105
106
107
108
109
110
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 105

def output
  [
    ['GITHUB_DELETE_PULL_COMMENT_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_DELETE_PULL_COMMENT_RESPONSE', 'The full response body returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



112
113
114
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_pull_comment_action.rb', line 112

def return_value
  "Returns a hash containing the status code and response body from the GitHub API."
end

.run(params) ⇒ Object 



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

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]
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/comments/#{comment_id}"
  
  UI.message("Deleting pull request comment #{comment_id} from #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    method: :delete,
    server_url: server_url
  )
  
  status_code = response[:status]
  result = {
    status: status_code,
    body: response[:body]
  }
  
  if status_code.between?(200, 299) || status_code == 204
    UI.success("Successfully deleted pull request comment #{comment_id}")
  else
    UI.error("Error deleting 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_DELETE_PULL_COMMENT_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_DELETE_PULL_COMMENT_RESPONSE] = response[:body]
  
  return result
end