Class: Fastlane::Actions::GithubCreatePullAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



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

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



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
149
150
151
152
153
154
155
156
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_action.rb', line 95

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: "Owner of the repository",
                         optional: false),
    FastlaneCore::ConfigItem.new(key: :repo_name,
                         env_name: "GITHUB_API_REPO_NAME",
                      description: "Name of the repository",
                         optional: false),
    FastlaneCore::ConfigItem.new(key: :title,
                         env_name: "GITHUB_API_PR_TITLE",
                      description: "The title of the pull request",
                         optional: false,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :head,
                         env_name: "GITHUB_API_PR_HEAD",
                      description: "The name of the branch where your changes are implemented (or user:branch for cross-repo PRs)",
                         optional: false,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :base,
                         env_name: "GITHUB_API_PR_BASE",
                      description: "The name of the branch you want the changes pulled into",
                         optional: false,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :body,
                         env_name: "GITHUB_API_PR_BODY",
                      description: "The body text content of the pull request",
                         optional: true,
                             type: String),
    FastlaneCore::ConfigItem.new(key: :maintainer_can_modify,
                         env_name: "GITHUB_API_PR_MAINTAINER_CAN_MODIFY",
                      description: "Whether maintainers can modify the pull request",
                         optional: true,
                             type: Boolean),
    FastlaneCore::ConfigItem.new(key: :draft,
                         env_name: "GITHUB_API_PR_DRAFT",
                      description: "Whether the pull request is a draft",
                         optional: true,
                             type: Boolean),
    FastlaneCore::ConfigItem.new(key: :issue,
                         env_name: "GITHUB_API_PR_ISSUE",
                      description: "The issue number to convert to a pull request",
                         optional: true,
                             type: Integer)
  ]
end

.description ⇒ Object 



83
84
85
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_action.rb', line 83

def description
  "Creates a new pull request in a GitHub repository"
end

.details ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_action.rb', line 87

def details
  [
    "Creates a new pull request in a GitHub repository with the specified title, head branch, base branch, 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/pulls/pulls#create-a-pull-request"
  ].join("\n")
end

.example_code ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_action.rb', line 178

def example_code
  [
    'github_create_pull(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      title: "Amazing new feature",
      head: "feature-branch",
      base: "main",
      body: "Please pull these awesome changes"
    )',
    'github_create_pull(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      title: "Bug fix for issue #42",
      head: "fix-branch",
      base: "main",
      body: "This PR fixes issue #42",
      draft: true
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_supported?(platform)
  true
end

.output ⇒ Object 



158
159
160
161
162
163
164
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_action.rb', line 158

def output
  [
    ['GITHUB_CREATE_PULL_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_CREATE_PULL_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_CREATE_PULL_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



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

def return_value
  "Returns a hash containing the status code, response body, and parsed JSON response from the GitHub API."
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
74
75
76
77
 
# File 'lib/fastlane/plugin/github_api/actions/github_create_pull_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 pull request, pass using `title: 'PR Title'`") if params[:title].to_s.empty?
  UI.user_error!("Head branch is required for pull request") if params[:head].to_s.empty?
  UI.user_error!("Base branch is required for pull request") if params[:base].to_s.empty?
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls"
  
  # Build body parameters
  body_params = {
    title: params[:title],
    head: params[:head],
    base: params[:base]
  }
  
  # Add optional parameters if provided
  body_params[:body] = params[:body] if params[:body]
  body_params[:maintainer_can_modify] = params[:maintainer_can_modify] unless params[:maintainer_can_modify].nil?
  body_params[:draft] = params[:draft] unless params[:draft].nil?
  body_params[:issue] = params[:issue] if params[:issue]
  
  UI.message("Creating pull request 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)
    pr_number = json_response['number']
    UI.success("Successfully created pull request ##{pr_number} in #{repo_owner}/#{repo_name}")
  else
    UI.error("Error creating pull request: #{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_PULL_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_JSON] = json_response
  
  return result
end