Class: Fastlane::Actions::GithubDeleteIssueCommentAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



128
129
130
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 128

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 76

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

.category ⇒ Object 



143
144
145
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 143

def category
  :source_control
end

.description ⇒ Object 



64
65
66
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 64

def description
  "Deletes a comment from a GitHub issue"
end

.details ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 68

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

.example_code ⇒ Object 



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 132

def example_code
  [
    'github_delete_issue_comment(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      comment_id: 12345678
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 147

def is_supported?(platform)
  true
end

.output ⇒ Object 



116
117
118
119
120
121
122
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 116

def output
  [
    ['GITHUB_DELETE_ISSUE_COMMENT_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_DELETE_ISSUE_COMMENT_RESPONSE', 'The full response body from the GitHub API'],
    ['GITHUB_DELETE_ISSUE_COMMENT_JSON', 'The parsed JSON returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



124
125
126
 
# File 'lib/fastlane/plugin/github_api/actions/github_delete_issue_comment_action.rb', line 124

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

def run(params)
  # 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 parameters
  UI.user_error!("No comment ID provided, pass using `comment_id: 12345678`") unless comment_id.to_s.length > 0
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/issues/comments/#{comment_id}"
  
  UI.message("Deleting comment ID: #{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],
    json: response[:json]
  }
  
  if status_code.between?(200, 299) || status_code == 204
    UI.success("Successfully deleted comment ID: #{comment_id} from #{repo_owner}/#{repo_name}")
  else
    UI.error("Error deleting 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_ISSUE_COMMENT_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_DELETE_ISSUE_COMMENT_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_DELETE_ISSUE_COMMENT_JSON] = response[:json]
  
  return result
end