org.kohsuke.github

Class GHPullRequest

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHIssue

org.kohsuke.github.GHPullRequest

All Implemented Interfaces:

Reactable

public class GHPullRequest
extends GHIssue

A pull request.

Author:

Kohsuke Kawaguchi

See Also:

GHRepository.getPullRequest(int)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHPullRequest.MergeMethod

Nested classes/interfaces inherited from class org.kohsuke.github.GHIssue

GHIssue.Label, GHIssue.PullRequest

Field Summary

Fields inherited from class org.kohsuke.github.GHIssue

assignee, assignees, body, closed_at, closed_by, comments, html_url, labels, locked, milestone, number, pull_request, state, title, user

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, responseHeaderFields, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHPullRequest()

Method Summary

Modifier and Type	Method and Description
boolean	canMaintainerModify()
GHPullRequestReviewBuilder	createReview()
GHPullRequestReview	createReview(String body, GHPullRequestReviewState event, GHPullRequestReviewComment... comments) Deprecated. Use createReview()
GHPullRequestReview	createReview(String body, GHPullRequestReviewState event, List<GHPullRequestReviewComment> comments) Deprecated. Use createReview()
GHPullRequestReviewComment	createReviewComment(String body, String sha, String path, int position)
int	getAdditions()
protected String	getApiRoute()
GHCommitPointer	getBase() This points to where the change should be pulled into, but I'm not really sure what exactly it means.
int	getChangedFiles()
GHUser	getClosedBy() Reports who has closed the issue.
int	getCommits()
int	getDeletions()
URL	getDiffUrl() The diff file, like https://github.com/jenkinsci/jenkins/pull/100.diff
GHCommitPointer	getHead() The change that should be pulled.
Date	getIssueUpdatedAt() Deprecated.
URL	getIssueUrl() The URL of the patch file.
Collection<GHLabel>	getLabels()
Boolean	getMergeable() Is this PR mergeable?
String	getMergeableState()
String	getMergeCommitSha() See GitHub blog post
Date	getMergedAt()
GHUser	getMergedBy()
URL	getPatchUrl() The URL of the patch file.
GHIssue.PullRequest	getPullRequest() Returns non-null if this issue is a shadow of a pull request.
int	getReviewComments()
boolean	isMerged()
PagedIterable<GHPullRequestCommitDetail>	listCommits() Retrieves all the commits associated to this pull request.
PagedIterable<GHPullRequestFileDetail>	listFiles() Retrieves all the files associated to this pull request.
PagedIterable<GHPullRequestReviewComment>	listReviewComments() Obtains all the review comments associated with this pull request.
PagedIterable<GHPullRequestReview>	listReviews() Retrieves all the reviews associated to this pull request.
void	merge(String msg) Merge this pull request.
void	merge(String msg, String sha) Merge this pull request.
void	merge(String msg, String sha, GHPullRequest.MergeMethod method) Merge this pull request, using the specified merge method.
void	refresh() Repopulates this object.

Methods inherited from class org.kohsuke.github.GHIssue

addAssignees, addAssignees, assignTo, close, comment, createReaction, getApiURL, getAssignee, getAssignees, getBody, getClosedAt, getComments, getCommentsCount, getHtmlUrl, getIssuesApiRoute, getMilestone, getNumber, getRepository, getState, getTitle, getUser, isLocked, isPullRequest, listComments, listReactions, lock, removeAssignees, removeAssignees, reopen, setAssignees, setAssignees, setBody, setLabels, setMilestone, setTitle, unlock

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getResponseHeaderFields, getUpdatedAt, getUrl, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GHPullRequest

public GHPullRequest()

Method Detail

getApiRoute

protected String getApiRoute()

Overrides:

getApiRoute in class GHIssue

getPatchUrl

public URL getPatchUrl()

The URL of the patch file. like https://github.com/jenkinsci/jenkins/pull/100.patch

getIssueUrl

public URL getIssueUrl()

The URL of the patch file. like https://github.com/jenkinsci/jenkins/pull/100.patch

getBase

public GHCommitPointer getBase()

This points to where the change should be pulled into, but I'm not really sure what exactly it means.

getHead

public GHCommitPointer getHead()

The change that should be pulled. The tip of the commits to merge.

getIssueUpdatedAt

@Deprecated
public Date getIssueUpdatedAt()
                                   throws IOException

Deprecated.

Throws:

IOException

getDiffUrl

public URL getDiffUrl()

The diff file, like https://github.com/jenkinsci/jenkins/pull/100.diff

getMergedAt

public Date getMergedAt()

getLabels

public Collection<GHLabel> getLabels()
                              throws IOException

Overrides:

getLabels in class GHIssue

Throws:

IOException

getClosedBy

public GHUser getClosedBy()

Description copied from class: GHIssue

Reports who has closed the issue.

Note that GitHub doesn't always seem to report this information even for an issue that's already closed. See https://github.com/kohsuke/github-api/issues/60.

Overrides:

getClosedBy in class GHIssue

getPullRequest

public GHIssue.PullRequest getPullRequest()

Description copied from class: GHIssue

Returns non-null if this issue is a shadow of a pull request.

Overrides:

getPullRequest in class GHIssue

getMergedBy

public GHUser getMergedBy()
                   throws IOException

Throws:

IOException

getReviewComments

public int getReviewComments()
                      throws IOException

Throws:

IOException

getAdditions

public int getAdditions()
                 throws IOException

Throws:

IOException

getCommits

public int getCommits()
               throws IOException

Throws:

IOException

isMerged

public boolean isMerged()
                 throws IOException

Throws:

IOException

canMaintainerModify

public boolean canMaintainerModify()
                            throws IOException

Throws:

IOException

getMergeable

public Boolean getMergeable()
                     throws IOException

Is this PR mergeable?

Returns:

null if the state has not been determined yet, for example when a PR is newly created. If this method is called on an instance whose mergeable state is not yet known, API call is made to retrieve the latest state.

Throws:

IOException

getDeletions

public int getDeletions()
                 throws IOException

Throws:

IOException

getMergeableState

public String getMergeableState()
                         throws IOException

Throws:

IOException

getChangedFiles

public int getChangedFiles()
                    throws IOException

Throws:

IOException

getMergeCommitSha

public String getMergeCommitSha()
                         throws IOException

See GitHub blog post

Throws:

IOException

refresh

public void refresh()
             throws IOException

Repopulates this object.

Throws:

IOException

listFiles

public PagedIterable<GHPullRequestFileDetail> listFiles()

Retrieves all the files associated to this pull request.

listReviews

public PagedIterable<GHPullRequestReview> listReviews()

Retrieves all the reviews associated to this pull request.

listReviewComments

public PagedIterable<GHPullRequestReviewComment> listReviewComments()
                                                             throws IOException

Obtains all the review comments associated with this pull request.

Throws:

IOException

listCommits

public PagedIterable<GHPullRequestCommitDetail> listCommits()

Retrieves all the commits associated to this pull request.

createReview

public GHPullRequestReview createReview(String body,
                                        @CheckForNull
                                        GHPullRequestReviewState event,
                                        GHPullRequestReviewComment... comments)
                                 throws IOException

Deprecated. Use createReview()

Throws:

IOException

createReview

public GHPullRequestReview createReview(String body,
                                        @CheckForNull
                                        GHPullRequestReviewState event,
                                        List<GHPullRequestReviewComment> comments)
                                 throws IOException

Deprecated. Use createReview()

Throws:

IOException

createReview

public GHPullRequestReviewBuilder createReview()

createReviewComment

public GHPullRequestReviewComment createReviewComment(String body,
                                                      String sha,
                                                      String path,
                                                      int position)
                                               throws IOException

Throws:

IOException

merge

public void merge(String msg)
           throws IOException

Merge this pull request. The equivalent of the big green "Merge pull request" button.

Parameters:

msg - Commit message. If null, the default one will be used.

Throws:

IOException

merge

public void merge(String msg,
                  String sha)
           throws IOException

Merge this pull request. The equivalent of the big green "Merge pull request" button.

Parameters:

msg - Commit message. If null, the default one will be used.

sha - SHA that pull request head must match to allow merge.

Throws:

IOException

merge

public void merge(String msg,
                  String sha,
                  GHPullRequest.MergeMethod method)
           throws IOException

Merge this pull request, using the specified merge method. The equivalent of the big green "Merge pull request" button.

Parameters:

msg - Commit message. If null, the default one will be used.

method - SHA that pull request head must match to allow merge.

Throws:

IOException