Class: Fastlane::Actions::GithubLockIssueAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



147
148
149
 
# File 'lib/fastlane/plugin/github_api/actions/github_lock_issue_action.rb', line 147

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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

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: "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 lock",
                         optional: false,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :lock_reason,
                      description: "The reason for locking the issue (off-topic, too heated, resolved, spam)",
                         optional: true,
                             type: String,
                      verify_block: proc do |value|
                        allowed_reasons = ['off-topic', 'too heated', 'resolved', 'spam']
                        UI.user_error!("Lock reason must be one of: #{allowed_reasons.join(', ')}") unless allowed_reasons.include?(value) || value.nil?
                      end)
  ]
end

.category ⇒ Object 



170
171
172
 
# File 'lib/fastlane/plugin/github_api/actions/github_lock_issue_action.rb', line 170

def category
  :source_control
end

.description ⇒ Object 



74
75
76
 
# File 'lib/fastlane/plugin/github_api/actions/github_lock_issue_action.rb', line 74

def description
  "Locks a GitHub issue"
end

.details ⇒ Object 



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

def details
  [
    "Locks an issue in a GitHub repository, preventing further comments.",
    "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
    "API Documentation: https://docs.github.com/en/rest/issues/issues#lock-an-issue"
  ].join("\n")
end

.example_code ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/fastlane/plugin/github_api/actions/github_lock_issue_action.rb', line 151

def example_code
  [
    'github_lock_issue(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      issue_number: 123
    )',
    '# Lock with a reason
    github_lock_issue(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      issue_number: 123,
      lock_reason: "resolved"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/fastlane/plugin/github_api/actions/github_lock_issue_action.rb', line 174

def is_supported?(platform)
  true
end

.output ⇒ Object 



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

def output
  [
    ['GITHUB_LOCK_ISSUE_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_LOCK_ISSUE_RESPONSE', 'The full response body from the GitHub API'],
    ['GITHUB_LOCK_ISSUE_JSON', 'The parsed JSON returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



143
144
145
 
# File 'lib/fastlane/plugin/github_api/actions/github_lock_issue_action.rb', line 143

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
 
# File 'lib/fastlane/plugin/github_api/actions/github_lock_issue_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]
  issue_number = params[:issue_number]
  lock_reason = params[:lock_reason]
  
  # Validate parameters
  UI.user_error!("No GitHub issue number given, pass using `issue_number: 123`") unless issue_number.to_s.length > 0
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/lock"
  
  # Build body parameters
  body_params = {}
  body_params[:lock_reason] = lock_reason if lock_reason
  
  UI.message("Locking issue ##{issue_number} in #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: body_params,
    method: :put,
    server_url: server_url
  )
  
  status_code = response[:status]
  json_response = response[:json]
  result = {
    status: status_code,
    body: response[:body],
    json: json_response
  }
  
  if status_code.between?(200, 299) || status_code == 204
    reason_text = lock_reason ? " with reason '#{lock_reason}'" : ""
    UI.success("Successfully locked issue ##{issue_number}#{reason_text}")
  else
    UI.error("Error locking issue: #{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_LOCK_ISSUE_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_LOCK_ISSUE_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_LOCK_ISSUE_JSON] = json_response
  
  return result
end