Class: Fastlane::Actions::GithubCreateIssueAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



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

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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

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: :title,
                      description: "The title of the issue",
                         optional: false,
                             type: String,
                      verify_block: proc do |value|
                        UI.user_error!("No title provided, pass using `title: 'Issue Title'`") if value.to_s.empty?
                      end),
    FastlaneCore::ConfigItem.new(key: :body,
                      description: "The body content of the issue",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :assignees,
                      description: "Array of logins for users to assign to the issue",
                         optional: true,
                             type: Array),
    FastlaneCore::ConfigItem.new(key: :milestone,
                      description: "The milestone number to associate with this issue",
                         optional: true,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :labels,
                      description: "Array of labels to associate with this issue",
                         optional: true,
                             type: Array)
  ]
end

.category ⇒ Object 



189
190
191
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_issue_action.rb', line 189

def category
  :source_control
end

.description ⇒ Object 



79
80
81
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_issue_action.rb', line 79

def description
  "Creates a new GitHub issue"
end

.details ⇒ Object 



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

def details
  [
    "Creates a new issue in a GitHub repository with the specified title, body, and other optional parameters.",
    "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#create-an-issue"
  ].join("\n")
end

.example_code ⇒ Object 



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

def example_code
  [
    'github_create_issue(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      title: "New Feature Request",
      body: "Please implement this awesome feature",
      labels: ["enhancement", "feature-request"],
      assignees: ["username1", "username2"]
    )',
    '# You can also access the response data
    result = github_create_issue(
      api_token: ENV["GITHUB_API_TOKEN"],
      repo_owner: "fastlane",
      repo_name: "fastlane",
      title: "Bug Report",
      body: "Something is not working"
    )
    UI.message("Created issue number: #{result[:json]["number"]}")'
  ]
end

.is_supported?(platform) ⇒ Boolean 



193
194
195
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_issue_action.rb', line 193

def is_supported?(platform)
  true
end

.output ⇒ Object 



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

def output
  [
    ['GITHUB_CREATE_ISSUE_STATUS_CODE', 'The status code returned from the GitHub API'],
    ['GITHUB_CREATE_ISSUE_RESPONSE', 'The full response body from the GitHub API'],
    ['GITHUB_CREATE_ISSUE_JSON', 'The parsed JSON returned from the GitHub API']
  ]
end

.return_value ⇒ Object 



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

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
73
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_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]
  
  # Validate parameters
  UI.user_error!("No title provided for issue, pass using `title: 'Issue Title'`") if params[:title].to_s.empty?
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/issues"
  
  # Build body parameters
  body_params = {
    title: params[:title],
    body: params[:body]
  }
  
  # Add optional parameters if provided
  body_params[:assignees] = params[:assignees] if params[:assignees]
  body_params[:milestone] = params[:milestone] if params[:milestone]
  body_params[:labels] = params[:labels] if params[:labels]
  
  UI.message("Creating new issue in #{repo_owner}/#{repo_name}: #{params[:title]}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: body_params,
    method: :post,
    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)
    issue_number = json_response['number']
    UI.success("Successfully created issue ##{issue_number} in #{repo_owner}/#{repo_name}")
  else
    UI.error("Error creating 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_CREATE_ISSUE_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_CREATE_ISSUE_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_CREATE_ISSUE_JSON] = json_response
  
  return result
end