Class: Fastlane::Actions::GithubRemoveAllLabelsAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



135
136
137
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_action.rb', line 135

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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

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

.category ⇒ Object 



150
151
152
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_action.rb', line 150

def category
  :source_control
end

.description ⇒ Object 



69
70
71
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_action.rb', line 69

def description
  "Removes all labels from a GitHub issue"
end

.details ⇒ Object 



73
74
75
76
77
78
79
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_action.rb', line 73

def details
  [
    "This action removes all labels from a specific 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-all-labels-from-an-issue)"
  ].join("\n")
end

.example_code ⇒ Object 



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_action.rb', line 139

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

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_supported?(platform)
  true
end

.output ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_action.rb', line 123

def output
  [
    ['GITHUB_REMOVE_ALL_LABELS_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_REMOVE_ALL_LABELS_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_REMOVE_ALL_LABELS_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



131
132
133
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_action.rb', line 131

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
 
# File 'lib/fastlane/plugin/github_api/actions/github_remove_all_labels_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]
  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
  
  # Prepare request parameters
  path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/labels"
  
  # Make the request
  UI.message("Removing all labels 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 all labels from issue ##{issue_number}")
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_REMOVE_ALL_LABELS_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_REMOVE_ALL_LABELS_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_REMOVE_ALL_LABELS_JSON] = response
  
  return result
end