Class: Fastlane::Actions::GithubCreateCommitCommentReactionAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



138
139
140
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_commit_comment_reaction_action.rb', line 138

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_commit_comment_reaction_action.rb', line 84

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_COMMENT_ID",
                      description: "The ID of the commit comment",
                         optional: false,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :content,
                         env_name: "GITHUB_API_REACTION_CONTENT",
                      description: "The reaction type (+1, -1, laugh, confused, heart, hooray, rocket, eyes)",
                         optional: false,
                             type: String,
                     verify_block: proc do |value|
                       valid_reactions = ['+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes']
                       UI.user_error!("Invalid reaction content: '#{value}'. Must be one of: #{valid_reactions.join(', ')}") unless valid_reactions.include?(value)
                     end)
  ]
end

.description ⇒ Object 



72
73
74
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_commit_comment_reaction_action.rb', line 72

def description
  "Create a reaction for a commit comment"
end

.details ⇒ Object 



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

def details
  [
    "Creates a reaction for a commit comment.",
    "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
    "API Documentation: https://docs.github.com/en/rest/reactions/reactions#create-reaction-for-a-commit-comment"
  ].join("\n")
end

.example_code ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_commit_comment_reaction_action.rb', line 146

def example_code
  [
    'github_create_commit_comment_reaction(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      comment_id: 123,
      content: "+1"
    )',
    'reaction = github_create_commit_comment_reaction(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      comment_id: 123,
      content: "heart"
    )
    
    puts "Created reaction: #{reaction[:json]["content"]}"
    puts "Reaction ID: #{reaction[:json]["id"]}"'
  ]
end

.is_supported?(platform) ⇒ Boolean 



142
143
144
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_commit_comment_reaction_action.rb', line 142

def is_supported?(platform)
  true
end

.output ⇒ Object 



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

def output
  [
    ['GITHUB_CREATE_COMMIT_COMMENT_REACTION_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_CREATE_COMMIT_COMMENT_REACTION_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_CREATE_COMMIT_COMMENT_REACTION_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



134
135
136
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_commit_comment_reaction_action.rb', line 134

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
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_commit_comment_reaction_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]
  content = params[:content]
  
  # Build the request body
  body = {
    content: content
  }
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/comments/#{comment_id}/reactions"
  
  UI.message("Creating '#{content}' reaction for commit comment ##{comment_id} in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: body,
    method: :post,
    server_url: server_url,
    headers: { 'Accept' => 'application/vnd.github.squirrel-girl-preview+json' }
  )
  
  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 '#{content}' reaction for commit comment ##{comment_id}")
  else
    UI.error("Error creating reaction: #{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_CREATE_COMMIT_COMMENT_REACTION_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_CREATE_COMMIT_COMMENT_REACTION_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_CREATE_COMMIT_COMMENT_REACTION_JSON] = json_response
  
  return result
end