Class: Fastlane::Actions::GithubRemoveLabelAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



146
147
148
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_label_action.rb', line 146

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
125
126
127
128
129
130
131
132
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_label_action.rb', line 85

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: :issue_number,
                         env_name: "GITHUB_API_ISSUE_NUMBER",
                         description: "The issue number to remove the label from",
                            optional: false,
                                type: Integer),
    FastlaneCore::ConfigItem.new(key: :label_name,
                         description: "The name of the label to remove",
                            optional: false,
                                type: String,
                       verify_block: proc do |value|
                          UI.user_error!("No label name provided, pass using `label_name: 'bug'`") if value.to_s.empty?
                        end)
  ]
end

.category ⇒ Object 



162
163
164
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_label_action.rb', line 162

def category
  :source_control
end

.description ⇒ Object 



73
74
75
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_label_action.rb', line 73

def description
  "Removes a label from a GitHub issue"
end

.details ⇒ Object 



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

def details
  [
    "This action removes a specific label from an issue in a GitHub repository.",
    "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#remove-a-label-from-an-issue)"
  ].join("\n")
end

.example_code ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_label_action.rb', line 150

def example_code
  [
    'github_remove_label(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      issue_number: 123,
      label_name: "bug"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


166
167
168
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_label_action.rb', line 166

def is_supported?(platform)
  true
end

.output ⇒ Object 



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

def output
  [
    ['GITHUB_REMOVE_LABEL_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_REMOVE_LABEL_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_REMOVE_LABEL_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



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

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

def run(params)
  token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  issue_number = params[:issue_number]
  label_name = params[:label_name]
  server_url = params[:server_url]
  
  # Validate parameters (additional validation beyond what's in ConfigItem)
  UI.user_error!("No GitHub issue number given, pass using `issue_number: 123`") unless issue_number.to_s.length > 0
  UI.user_error!("No label name provided, pass using `label_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}/issues/#{issue_number}/labels/#{encoded_label}"
  
  # Make the request
  UI.message("Removing label '#{label_name}' from issue ##{issue_number} in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: token,
    path: path,
    method: :delete,
    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.is_a?(Hash) && 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 removed label '#{label_name}' from issue ##{issue_number}")
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_REMOVE_LABEL_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_REMOVE_LABEL_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_REMOVE_LABEL_JSON] = response
  
  return result
end