Class: Fastlane::Actions::GithubUpdateLabelAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



167
168
169
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 167

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 95

def available_options
  [
    FastlaneCore::ConfigItem.new(key: :api_token,
                            env_name: "GITHUB_API_TOKEN",
                         description: "GitHub API token with repo permissions",
                            optional: false,
                                type: String,
                           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: :name,
                         description: "The current name of the label",
                            optional: false,
                                type: String,
                       verify_block: proc do |value|
                          UI.user_error!("No label name provided, pass using `name: 'bug'`") if value.to_s.empty?
                        end),
    FastlaneCore::ConfigItem.new(key: :new_name,
                         description: "The new name for the label",
                            optional: true,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :color,
                         description: "The color of the label in hexadecimal format (with or without leading #)",
                            optional: true,
                                type: String,
                         verify_block: proc do |value|
                           value = value[1..-1] if value.start_with?('#')
                           UI.user_error!("Color must be a valid 6 character hex code") unless value.match?(/^[0-9A-Fa-f]{6}$/)
                         end),
    FastlaneCore::ConfigItem.new(key: :description,
                         description: "A short description of the label",
                            optional: true,
                                type: String)
  ]
end

.category ⇒ Object 



194
195
196
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 194

def category
  :source_control
end

.description ⇒ Object 



83
84
85
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 83

def description
  "Updates a label in a GitHub repository"
end

.details ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 87

def details
  [
    "This action updates an existing label in a GitHub repository, allowing changes to its name, color, and description.",
    "It requires a valid GitHub API token with appropriate permissions.",
    "Documentation: [https://docs.github.com/en/rest/issues/labels](https://docs.github.com/en/rest/issues/labels#update-a-label)"
  ].join("\n")
end

.example_code ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 171

def example_code
  [
    'github_update_label(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      name: "bug",
      new_name: "confirmed-bug",
      color: "b60205",
      description: "Confirmed bugs that need to be fixed"
    )',
    '# You can also access the response data
    result = github_update_label(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      name: "enhancement",
      color: "a2eeef"
    )
    UI.message("Updated label color: #{result[:json]["color"]}")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


198
199
200
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 198

def is_supported?(platform)
  true
end

.output ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 155

def output
  [
    ['GITHUB_UPDATE_LABEL_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_UPDATE_LABEL_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_UPDATE_LABEL_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



163
164
165
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 163

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_label_action.rb', line 14

def run(params)
  token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  label_name = params[:name]
  server_url = params[:server_url]
  
  # Validate parameters (additional validation beyond what's in ConfigItem)
  UI.user_error!("No label name provided, pass using `name: 'bug'`") if label_name.to_s.empty?
  
  # Prepare request parameters
  # URL encode the label name to handle special characters like spaces, etc.
  encoded_label = URI.encode_www_form_component(label_name)
  path = "/repos/#{repo_owner}/#{repo_name}/labels/#{encoded_label}"
  
  # Build body parameters
  body_params = {}
  body_params[:new_name] = params[:new_name] if params[:new_name]
  
  if params[:color]
    body_params[:color] = params[:color].start_with?('#') ? params[:color][1..-1] : params[:color]
  end
  
  body_params[:description] = params[:description] if params[:description]
  
  # Make the request
  UI.message("Updating label '#{label_name}' in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: token,
    path: path,
    params: body_params,
    method: :patch,
    server_url: server_url
  )
  
  status_code = response.key?('status') ? response['status'] : nil
  result = {
    status: status_code,
    body: response,
    json: response
  }
  
  if response.key?('error')
    UI.error("GitHub responded with an error: #{response['error']}")
    UI.user_error!("GitHub API error: #{response['error']}")
    return nil
  end
  
  if response['message'] && status_code && status_code >= 400
    UI.error("GitHub API error: #{response['message']}")
    UI.user_error!("GitHub API error: #{response['message']} (Status code: #{status_code})")
    return nil
  end
  
  new_name = params[:new_name] || label_name
  UI.success("Successfully updated label '#{new_name}' in #{repo_owner}/#{repo_name}")
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_UPDATE_LABEL_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_UPDATE_LABEL_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_UPDATE_LABEL_JSON] = response
  
  return result
end