class Github::Client::PullRequests
def commits(*args)
- Api: - public
def commits(*args) arguments(args, required: [:user, :repo, :number]) response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/commits", arguments.params) return response unless block_given? response.each { |el| yield el } end
def create(*args)
- Api: - public
Options Hash:
(**params)
-
:issue
(Numeric
) -- -
:head
(String
) -- -
:base
(String
) -- -
:body
(String
) -- -
:title
(String
) --
Parameters:
-
params
(Hash
) --
def create(*args) arguments(args, required: [:user, :repo]) post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls", arguments.params) end
def files(*args)
- Api: - public
def files(*args) arguments(args, required: [:user, :repo, :number]) response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/files", arguments.params) return response unless block_given? response.each { |el| yield el } end
def get(*args)
pulls.get 'user-name', 'repo-name', 'number'
pulls = Github::PullRequests.new
github.pull_requests.get 'user-name', 'repo-name', 'number'
github = Github.new
= Examples
Get a single pull request
def get(*args) arguments(args, required: [:user, :repo, :number]) get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}", arguments.params) end
def list(*args)
- Api: - public
def list(*args) arguments(args, required: [:user, :repo]) response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls", arguments.params) return response unless block_given? response.each { |el| yield el } end
def merge(*args)
- Api: - public
Options Hash:
(**params)
-
:squash
(Boolean
) -- -
:sha
(String
) -- -
:commit_message
(String
) -- -
:commit_title
(String
) --
Parameters:
-
params
(Hash
) --
def merge(*args) arguments(args, required: [:user, :repo, :number]) params = arguments.params params['accept'] ||= PREVIEW_MEDIA put_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/merge", params) end
def merged?(*args)
- Api: - public
def merged?(*args) arguments(args, required: [:user, :repo, :number]) get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/merge", arguments.params) true rescue Github::Error::NotFound false end
def update(*args)
- Api: - public
Options Hash:
(**params)
-
:state
(String
) -- -
:title
(String
) --
Parameters:
-
params
(Hash
) --
def update(*args) arguments(args, required: [:user, :repo, :number]) patch_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}", arguments.params) end