Class: Fastlane::Actions::GithubCreateLabelAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



158
159
160
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_label_action.rb', line 158

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
142
143
144
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_label_action.rb', line 90

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 name of the label",
                            optional: false,
                                type: String,
                       verify_block: proc do |value|
                          UI.user_error!("No name provided, pass using `name: 'bug'`") if value.to_s.empty?
                        end),
    FastlaneCore::ConfigItem.new(key: :color,
                         description: "The color of the label in hexadecimal format (with or without leading #)",
                            optional: false,
                                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 



184
185
186
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_label_action.rb', line 184

def category
  :source_control
end

.description ⇒ Object 



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

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

.details ⇒ Object 



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

def details
  [
    "This action creates a new label in a GitHub repository with the specified name, color, and optional 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#create-a-label)"
  ].join("\n")
end

.example_code ⇒ Object 



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

def example_code
  [
    'github_create_label(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      name: "bug",
      color: "d73a4a",
      description: "Something isn\'t working"
    )',
    '# You can also access the response data
    result = github_create_label(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      name: "enhancement",
      color: "a2eeef"
    )
    UI.message("Created label with ID: #{result[:json]["id"]}")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_label_action.rb', line 188

def is_supported?(platform)
  true
end

.output ⇒ Object 



146
147
148
149
150
151
152
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_label_action.rb', line 146

def output
  [
    ['GITHUB_CREATE_LABEL_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_CREATE_LABEL_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_CREATE_LABEL_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



154
155
156
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_label_action.rb', line 154

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

def run(params)
  token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_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 params[:name].to_s.empty?
  UI.user_error!("No color provided, pass using `color: 'ff0000'`") if params[:color].to_s.empty?
  
  # Prepare request parameters
  path = "/repos/#{repo_owner}/#{repo_name}/labels"
  
  # Build body parameters
  body_params = {
    name: params[:name],
    color: params[:color].start_with?('#') ? params[:color][1..-1] : params[:color]
  }
  
  body_params[:description] = params[:description] if params[:description]
  
  # Make the request
  UI.message("Creating label '#{params[:name]}' in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: token,
    path: path,
    params: body_params,
    method: :post,
    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
  
  UI.success("Successfully created label '#{params[:name]}' in #{repo_owner}/#{repo_name}")
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_CREATE_LABEL_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_CREATE_LABEL_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_CREATE_LABEL_JSON] = response
  
  return result
end