Class: Fastlane::Actions::GithubUpdateMilestoneAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



161
162
163
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb', line 161

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb', line 89

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: :milestone_number,
                         description: "The milestone number to update",
                            optional: false,
                                type: Integer),
    FastlaneCore::ConfigItem.new(key: :title,
                         description: "The title of the milestone",
                            optional: true,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :state,
                         description: "The state of the milestone (open or closed)",
                            optional: true,
                                type: String,
                         verify_block: proc do |value|
                           UI.user_error!("State must be 'open' or 'closed'") unless ['open', 'closed'].include?(value)
                         end),
    FastlaneCore::ConfigItem.new(key: :description,
                         description: "A description of the milestone",
                            optional: true,
                                type: String),
    FastlaneCore::ConfigItem.new(key: :due_on,
                         description: "The milestone due date in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)",
                            optional: true,
                                type: String)
  ]
end

.category ⇒ Object 



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

def category
  :source_control
end

.description ⇒ Object 



77
78
79
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb', line 77

def description
  "Updates an existing milestone in a GitHub repository"
end

.details ⇒ Object 



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

def details
  [
    "This action updates an existing milestone in a GitHub repository with the specified parameters.",
    "It requires a valid GitHub API token with appropriate permissions.",
    "Documentation: [https://docs.github.com/en/rest/issues/milestones](https://docs.github.com/en/rest/issues/milestones#update-a-milestone)"
  ].join("\n")
end

.example_code ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb', line 165

def example_code
  [
    'github_update_milestone(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      milestone_number: 42,
      title: "v1.1",
      state: "closed",
      description: "First minor update"
    )',
    '# You can also access the response data
    result = github_update_milestone(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      milestone_number: 42,
      state: "closed"
    )
    UI.message("Updated milestone title: #{result[:json]["title"]}")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


192
193
194
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb', line 192

def is_supported?(platform)
  true
end

.output ⇒ Object 



149
150
151
152
153
154
155
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb', line 149

def output
  [
    ['GITHUB_UPDATE_MILESTONE_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_UPDATE_MILESTONE_RESPONSE', 'The full response from the GitHub API'],
    ['GITHUB_UPDATE_MILESTONE_JSON', 'The JSON data returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



157
158
159
 
# File 'lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb', line 157

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

def run(params)
  token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  milestone_number = params[:milestone_number]
  server_url = params[:server_url]
  
  # Validate parameters (additional validation beyond what's in ConfigItem)
  UI.user_error!("No GitHub milestone number given, pass using `milestone_number: 42`") unless milestone_number.to_s.length > 0
  
  # Prepare request parameters
  path = "/repos/#{repo_owner}/#{repo_name}/milestones/#{milestone_number}"
  
  # Build body parameters
  body_params = {}
  body_params[:title] = params[:title] if params[:title]
  body_params[:state] = params[:state] if params[:state]
  body_params[:description] = params[:description] if params[:description]
  body_params[:due_on] = params[:due_on] if params[:due_on]
  
  # Make the request
  UI.message("Updating milestone ##{milestone_number} 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
  
  UI.success("Successfully updated milestone ##{milestone_number} - #{response['title']} in #{repo_owner}/#{repo_name}")
  
  # Set the shared values
  Actions.lane_context[SharedValues::GITHUB_UPDATE_MILESTONE_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_UPDATE_MILESTONE_RESPONSE] = response
  Actions.lane_context[SharedValues::GITHUB_UPDATE_MILESTONE_JSON] = response
  
  return result
end