Module: Octokit::Client::Pulls
- Included in:
- Octokit::Client
- Defined in:
- lib/octokit/client/pulls.rb
Instance Method Summary collapse
-
#create_pull_request(repo, base, head, title, body, options = {}) ⇒ Hashie::Mash
Create a pull request.
-
#create_pull_request_comment(repo, pull_id, body, commit_id, path, position, options = {}) ⇒ Hashie::Mash
(also: #create_pull_comment, #create_view_comment)
Create a pull request comment.
-
#create_pull_request_comment_reply(repo, pull_id, body, comment_id, options = {}) ⇒ Hashie::Mash
(also: #create_pull_reply, #create_review_reply)
Create reply to a pull request comment.
-
#create_pull_request_for_issue(repo, base, head, issue, options = {}) ⇒ Hashie::Mash
Create a pull request from existing issue.
-
#delete_pull_request_comment(repo, comment_id, options = {}) ⇒ Boolean
(also: #delete_pull_comment, #delete_review_comment)
Delete pull request comment.
-
#merge_pull_request(repo, number, commit_message = '', options = {}) ⇒ Array<Hashie::Mash>
Merge a pull request.
-
#pull_merged?(repo, number, options = {}) ⇒ Boolean
(also: #pull_request_merged?)
Check pull request merge status.
-
#pull_request(repo, number, options = {}) ⇒ Hashie::Mash
(also: #pull)
Get a pull request.
-
#pull_request_comment(repo, comment_id, options = {}) ⇒ Hashie::Mash
(also: #pull_comment, #review_comment)
Get a pull request comment.
-
#pull_request_comments(repo, number, options = {}) ⇒ Array<Hashie::Mash>
(also: #pull_comments, #review_comments)
List comments on a pull request.
-
#pull_request_commits(repo, number, options = {}) ⇒ Array<Hashie::Mash>
(also: #pull_commits)
List commits on a pull request.
-
#pull_request_files(repo, number, options = {}) ⇒ Array<Hashie::Mash>
(also: #pull_files)
List files on a pull request.
-
#pull_requests(repo, state = 'open', options = {}) ⇒ Array<Hashie::Mash>
(also: #pulls)
List pull requests for a repository.
-
#pull_requests_comments(repo, options = {}) ⇒ Array
(also: #pulls_comments, #reviews_comments)
List pull request comments for a repository.
-
#update_pull_request(repo, id, title = nil, body = nil, state = nil, options = {}) ⇒ Hashie::Mash
Update a pull request.
-
#update_pull_request_comment(repo, comment_id, body, options = {}) ⇒ Hashie::Mash
(also: #update_pull_comment, #update_review_comment)
Update pull request comment.
Instance Method Details
#create_pull_request(repo, base, head, title, body, options = {}) ⇒ Hashie::Mash
Create a pull request
41 42 43 44 45 46 47 48 49 |
# File 'lib/octokit/client/pulls.rb', line 41 def create_pull_request(repo, base, head, title, body, ={}) pull = { :base => base, :head => head, :title => title, :body => body, } post("repos/#{Repository.new(repo)}/pulls", .merge(pull)) end |
#create_pull_request_comment(repo, pull_id, body, commit_id, path, position, options = {}) ⇒ Hashie::Mash Also known as: create_pull_comment, create_view_comment
Create a pull request comment
179 180 181 182 183 184 185 186 187 |
# File 'lib/octokit/client/pulls.rb', line 179 def create_pull_request_comment(repo, pull_id, body, commit_id, path, position, ={}) .merge!({ :body => body, :commit_id => commit_id, :path => path, :position => position }) post("repos/#{Repository.new repo}/pulls/#{pull_id}/comments", ) end |
#create_pull_request_comment_reply(repo, pull_id, body, comment_id, options = {}) ⇒ Hashie::Mash Also known as: create_pull_reply, create_review_reply
Create reply to a pull request comment
201 202 203 204 205 206 207 |
# File 'lib/octokit/client/pulls.rb', line 201 def create_pull_request_comment_reply(repo, pull_id, body, comment_id, ={}) .merge!({ :body => body, :in_reply_to => comment_id }) post("repos/#{Repository.new repo}/pulls/#{pull_id}/comments", ) end |
#create_pull_request_for_issue(repo, base, head, issue, options = {}) ⇒ Hashie::Mash
Create a pull request from existing issue
62 63 64 65 66 67 68 69 |
# File 'lib/octokit/client/pulls.rb', line 62 def create_pull_request_for_issue(repo, base, head, issue, ={}) pull = { :base => base, :head => head, :issue => issue } post("repos/#{Repository.new(repo)}/pulls", .merge(pull)) end |
#delete_pull_request_comment(repo, comment_id, options = {}) ⇒ Boolean Also known as: delete_pull_comment, delete_review_comment
Delete pull request comment
234 235 236 |
# File 'lib/octokit/client/pulls.rb', line 234 def delete_pull_request_comment(repo, comment_id, ={}) boolean_from_response(:delete, "repos/#{Repository.new repo}/pulls/comments/#{comment_id}", ) end |
#merge_pull_request(repo, number, commit_message = '', options = {}) ⇒ Array<Hashie::Mash>
Merge a pull request
258 259 260 |
# File 'lib/octokit/client/pulls.rb', line 258 def merge_pull_request(repo, number, ='', ={}) put("repos/#{Repository.new(repo)}/pulls/#{number}/merge", .merge({:commit_message => })) end |
#pull_merged?(repo, number, options = {}) ⇒ Boolean Also known as: pull_request_merged?
Check pull request merge status
268 269 270 |
# File 'lib/octokit/client/pulls.rb', line 268 def pull_merged?(repo, number, ={}) boolean_from_response(:get, "repos/#{Repository.new(repo)}/pulls/#{number}/merge", ) end |
#pull_request(repo, number, options = {}) ⇒ Hashie::Mash Also known as: pull
Get a pull request
24 25 26 |
# File 'lib/octokit/client/pulls.rb', line 24 def pull_request(repo, number, ={}) get("repos/#{Repository.new(repo)}/pulls/#{number}", ) end |
#pull_request_comment(repo, comment_id, options = {}) ⇒ Hashie::Mash Also known as: pull_comment, review_comment
Get a pull request comment
160 161 162 |
# File 'lib/octokit/client/pulls.rb', line 160 def pull_request_comment(repo, comment_id, ={}) get("repos/#{Repository.new repo}/pulls/comments/#{comment_id}", ) end |
#pull_request_comments(repo, number, options = {}) ⇒ Array<Hashie::Mash> Also known as: pull_comments, review_comments
List comments on a pull request
145 146 147 148 |
# File 'lib/octokit/client/pulls.rb', line 145 def pull_request_comments(repo, number, ={}) # return the comments for a pull request get("repos/#{Repository.new(repo)}/pulls/#{number}/comments", ) end |
#pull_request_commits(repo, number, options = {}) ⇒ Array<Hashie::Mash> Also known as: pull_commits
List commits on a pull request
103 104 105 |
# File 'lib/octokit/client/pulls.rb', line 103 def pull_request_commits(repo, number, ={}) get("repos/#{Repository.new(repo)}/pulls/#{number}/commits", ) end |
#pull_request_files(repo, number, options = {}) ⇒ Array<Hashie::Mash> Also known as: pull_files
List files on a pull request
246 247 248 |
# File 'lib/octokit/client/pulls.rb', line 246 def pull_request_files(repo, number, ={}) get("repos/#{Repository.new(repo)}/pulls/#{number}/files", ) end |
#pull_requests(repo, state = 'open', options = {}) ⇒ Array<Hashie::Mash> Also known as: pulls
List pull requests for a repository
13 14 15 |
# File 'lib/octokit/client/pulls.rb', line 13 def pull_requests(repo, state='open', ={}) get("repos/#{Repository.new(repo)}/pulls", .merge({:state => state})) end |
#pull_requests_comments(repo, options = {}) ⇒ Array Also known as: pulls_comments, reviews_comments
List pull request comments for a repository
By default, Review Comments are ordered by ascending ID.
133 134 135 |
# File 'lib/octokit/client/pulls.rb', line 133 def pull_requests_comments(repo, ={}) get("repos/#{Repository.new repo}/pulls/comments") end |
#update_pull_request(repo, id, title = nil, body = nil, state = nil, options = {}) ⇒ Hashie::Mash
Update a pull request
86 87 88 89 90 91 92 93 94 |
# File 'lib/octokit/client/pulls.rb', line 86 def update_pull_request(repo, id, title=nil, body=nil, state=nil, ={}) .merge!({ :title => title, :body => body, :state => state }) .reject! { |_, value| value.nil? } post("repos/#{Repository.new repo}/pulls/#{id}", ) end |
#update_pull_request_comment(repo, comment_id, body, options = {}) ⇒ Hashie::Mash Also known as: update_pull_comment, update_review_comment
Update pull request comment
220 221 222 223 |
# File 'lib/octokit/client/pulls.rb', line 220 def update_pull_request_comment(repo, comment_id, body, ={}) .merge! :body => body patch("repos/#{Repository.new repo}/pulls/comments/#{comment_id}", ) end |