Class: Fastlane::Actions::CreatePullRequestAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/create_pull_request.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, deprecated_notes, details, lane_context, method_missing, other_action, return_type, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.add_assignees(params, number) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 71

def self.add_assignees(params, number)
  payload = {
    'assignees' => params[:assignees]
  }
  GithubApiAction.run(
    server_url: params[:api_url],
    api_token: params[:api_token],
    http_method: 'POST',
    path: "repos/#{params[:repo]}/issues/#{number}/assignees",
    body: payload,
    error_handlers: {
      '*' => proc do |result|
        UI.error("GitHub responded with #{result[:status]}: #{result[:body]}")
        return nil
      end
    }
  )
end

.add_labels(params, number) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 52

def self.add_labels(params, number)
  payload = {
    'labels' => params[:labels]
  }
  GithubApiAction.run(
    server_url: params[:api_url],
    api_token: params[:api_token],
    http_method: 'PATCH',
    path: "repos/#{params[:repo]}/issues/#{number}",
    body: payload,
    error_handlers: {
      '*' => proc do |result|
        UI.error("GitHub responded with #{result[:status]}: #{result[:body]}")
        return nil
      end
    }
  )
end

.add_reviewers(params, number) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 90

def self.add_reviewers(params, number)
  payload = {}
  if params[:reviewers]
    payload["reviewers"] = params[:reviewers]
  end

  if params[:team_reviewers]
    payload["team_reviewers"] = params[:team_reviewers]
  end
  GithubApiAction.run(
    server_url: params[:api_url],
    api_token: params[:api_token],
    http_method: 'POST',
    path: "repos/#{params[:repo]}/pulls/#{number}/requested_reviewers",
    body: payload,
    error_handlers: {
      '*' => proc do |result|
        UI.error("GitHub responded with #{result[:status]}: #{result[:body]}")
        return nil
      end
    }
  )
end

.author ⇒ Object 



199
200
201
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 199

def self.author
  ["seei", "tommeier", "marumemomo", "elneruda"]
end

.available_options ⇒ Object 



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 129

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :api_token,
                                 env_name: "GITHUB_PULL_REQUEST_API_TOKEN",
                                 description: "Personal API Token for GitHub - generate one at https://github.com/settings/tokens",
                                 sensitive: true,
                                 code_gen_sensitive: true,
                                 default_value: ENV["GITHUB_API_TOKEN"],
                                 default_value_dynamic: true,
                                 is_string: true,
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :repo,
                                 env_name: "GITHUB_PULL_REQUEST_REPO",
                                 description: "The name of the repository you want to submit the pull request to",
                                 is_string: true,
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :title,
                                 env_name: "GITHUB_PULL_REQUEST_TITLE",
                                 description: "The title of the pull request",
                                 is_string: true,
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :body,
                                 env_name: "GITHUB_PULL_REQUEST_BODY",
                                 description: "The contents of the pull request",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :labels,
                                 env_name: "GITHUB_PULL_REQUEST_LABELS",
                                 description: "The labels for the pull request",
                                 type: Array,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :head,
                                 env_name: "GITHUB_PULL_REQUEST_HEAD",
                                 description: "The name of the branch where your changes are implemented (defaults to the current branch name)",
                                 is_string: true,
                                 code_gen_sensitive: true,
                                 default_value: Actions.git_branch,
                                 default_value_dynamic: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :base,
                                 env_name: "GITHUB_PULL_REQUEST_BASE",
                                 description: "The name of the branch you want your changes pulled into (defaults to `master`)",
                                 is_string: true,
                                 default_value: 'master',
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :api_url,
                                 env_name: "GITHUB_PULL_REQUEST_API_URL",
                                 description: "The URL of GitHub API - used when the Enterprise (default to `https://api.github.com`)",
                                 is_string: true,
                                 code_gen_default_value: 'https://api.github.com',
                                 default_value: 'https://api.github.com',
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :assignees,
                                 env_name: "GITHUB_PULL_REQUEST_ASSIGNEES",
                                 description: "The assignees for the pull request",
                                 type: Array,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :reviewers,
                                 env_name: "GITHUB_PULL_REQUEST_REVIEWERS",
                                 description: "The reviewers (slug) for the pull request",
                                 type: Array,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :team_reviewers,
                                 env_name: "GITHUB_PULL_REQUEST_TEAM_REVIEWERS",
                                 description: "The team reviewers (slug) for the pull request",
                                 type: Array,
                                 optional: true)
  ]
end

.category ⇒ Object 



225
226
227
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 225

def self.category
  :source_control
end

.description ⇒ Object 



118
119
120
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 118

def self.description
  "This will create a new pull request on GitHub"
end

.example_code ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 211

def self.example_code
  [
    'create_pull_request(
      api_token: "secret",                # optional, defaults to ENV["GITHUB_API_TOKEN"]
      repo: "fastlane/fastlane",
      title: "Amazing new feature",
      head: "my-feature",                 # optional, defaults to current branch name
      base: "master",                     # optional, defaults to "master"
      body: "Please pull this in!",       # optional
      api_url: "http://yourdomain/api/v3" # optional, for GitHub Enterprise, defaults to "https://api.github.com"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



203
204
205
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 203

def self.is_supported?(platform)
  return true
end

.output ⇒ Object 



122
123
124
125
126
127
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 122

def self.output
  [
    ['CREATE_PULL_REQUEST_HTML_URL', 'The HTML URL to the created pull request'],
    ['CREATE_PULL_REQUEST_NUMBER', 'The identifier number of the created pull request']
  ]
end

.return_value ⇒ Object 



207
208
209
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 207

def self.return_value
  "The pull request URL when successful"
end

.run(params) ⇒ Object 



9
10
11
12
13
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
 
# File 'fastlane/lib/fastlane/actions/create_pull_request.rb', line 9

def self.run(params)
  UI.message("Creating new pull request from '#{params[:head]}' to branch '#{params[:base]}' of '#{params[:repo]}'")

  payload = {
    'title' => params[:title],
    'head' => params[:head],
    'base' => params[:base]
  }
  payload['body'] = params[:body] if params[:body]

  GithubApiAction.run(
    server_url: params[:api_url],
    api_token: params[:api_token],
    http_method: 'POST',
    path: "repos/#{params[:repo]}/pulls",
    body: payload,
    error_handlers: {
      '*' => proc do |result|
        UI.error("GitHub responded with #{result[:status]}: #{result[:body]}")
        return nil
      end
    }
  ) do |result|
    json = result[:json]
    number = json['number']
    html_url = json['html_url']
    UI.success("Successfully created pull request ##{number}. You can see it at '#{html_url}'")

    # Add labels to pull request
    add_labels(params, number) if params[:labels]

    # Add assignees to pull request
    add_assignees(params, number) if params[:assignees]

    # Add reviewers to pull request
    add_reviewers(params, number) if params[:reviewers] || params[:team_reviewers]

    Actions.lane_context[SharedValues::CREATE_PULL_REQUEST_HTML_URL] = html_url
    Actions.lane_context[SharedValues::CREATE_PULL_REQUEST_NUMBER] = number
    return html_url
  end
end