org.kohsuke.github

Class GHRepository

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHRepository

public class GHRepository
extends GHObject

A repository on GitHub.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHRepository.Contributor
static class	GHRepository.ForkSort Sort orders for listing forks

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHRepository()

Method Summary

Modifier and Type	Method and Description
void	addCollaborators(java.util.Collection<GHUser> users)
void	addCollaborators(GHUser... users)
GHDeployKey	addDeployKey(java.lang.String title, java.lang.String key)
GHCommitStatus	createCommitStatus(java.lang.String sha1, GHCommitState state, java.lang.String targetUrl, java.lang.String description)
GHCommitStatus	createCommitStatus(java.lang.String sha1, GHCommitState state, java.lang.String targetUrl, java.lang.String description, java.lang.String context) Creates a commit status
GHContentUpdateResponse	createContent(byte[] contentBytes, java.lang.String commitMessage, java.lang.String path)
GHContentUpdateResponse	createContent(byte[] contentBytes, java.lang.String commitMessage, java.lang.String path, java.lang.String branch)
GHContentUpdateResponse	createContent(java.lang.String content, java.lang.String commitMessage, java.lang.String path)
GHContentUpdateResponse	createContent(java.lang.String content, java.lang.String commitMessage, java.lang.String path, java.lang.String branch)
GHDeploymentBuilder	createDeployment(java.lang.String ref)
GHDeploymentStatusBuilder	createDeployStatus(int deploymentId, GHDeploymentState ghDeploymentState)
GHHook	createHook(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> config, java.util.Collection<GHEvent> events, boolean active) See https://api.github.com/hooks for possible names and their configuration scheme.
GHIssueBuilder	createIssue(java.lang.String title)
GHLabel	createLabel(java.lang.String name, java.lang.String color)
GHMilestone	createMilestone(java.lang.String title, java.lang.String description)
GHPullRequest	createPullRequest(java.lang.String title, java.lang.String head, java.lang.String base, java.lang.String body) Creates a new pull request.
GHRef	createRef(java.lang.String name, java.lang.String sha) Creates a named ref, such as tag, branch, etc.
GHReleaseBuilder	createRelease(java.lang.String tag)
GHHook	createWebHook(java.net.URL url)
GHHook	createWebHook(java.net.URL url, java.util.Collection<GHEvent> events)
void	delete() Deletes this repository.
void	enableDownloads(boolean v)
void	enableIssueTracker(boolean v) Enables or disables the issue tracker for this repository.
void	enableWiki(boolean v) Enables or disables Wiki for this repository.
boolean	equals(java.lang.Object obj)
GHRepository	fork() Forks this repository as your repository.
GHRepository	forkTo(GHOrganization org) Forks this repository into an organization.
GHBranch	getBranch(java.lang.String name)
java.util.Map<java.lang.String,GHBranch>	getBranches() Gets branches by their names.
java.util.Set<java.lang.String>	getCollaboratorNames() Gets the names of the collaborators on this repository.
GHPersonSet<GHUser>	getCollaborators() Gets the collaborators on this repository.
GHCommit	getCommit(java.lang.String sha1) Gets a commit object in this repository.
GHCompare	getCompare(GHBranch id1, GHBranch id2)
GHCompare	getCompare(GHCommit id1, GHCommit id2)
GHCompare	getCompare(java.lang.String id1, java.lang.String id2) Gets a comparison between 2 points in the repository.
java.lang.String	getDefaultBranch() Returns the primary branch you'll configure in the "Admin > Options" config page.
java.util.List<GHDeployKey>	getDeployKeys()
PagedIterable<GHDeploymentStatus>	getDeploymentStatuses(int id)
java.lang.String	getDescription()
java.util.List<GHContent>	getDirectoryContent(java.lang.String path)
java.util.List<GHContent>	getDirectoryContent(java.lang.String path, java.lang.String ref)
GHContent	getFileContent(java.lang.String path)
GHContent	getFileContent(java.lang.String path, java.lang.String ref)
int	getForks() Returns the number of all forks of this repository.
java.lang.String	getFullName() Full repository name including the owner or organization.
java.lang.String	getGitTransportUrl() Gets the git:// URL to this repository, such as "git://github.com/kohsuke/jenkins.git" This URL is read-only.
java.lang.String	getHomepage()
GHHook	getHook(int id)
java.util.List<GHHook>	getHooks() Retrieves the currently configured hooks.
java.net.URL	getHtmlUrl() URL of this object for humans, which renders some HTML.
GHIssue	getIssue(int id)
java.util.List<GHIssue>	getIssues(GHIssueState state)
java.util.List<GHIssue>	getIssues(GHIssueState state, GHMilestone milestone)
GHLabel	getLabel(java.lang.String name)
java.lang.String	getLanguage() Gets the primary programming language.
GHCommitStatus	getLastCommitStatus(java.lang.String sha1) Gets the last status of this commit, which is what gets shown in the UI.
GHLicense	getLicense() Deprecated.
GHContent	getLicenseContent() Deprecated.
java.lang.String	getMasterBranch() Deprecated. Renamed to getDefaultBranch()
GHMilestone	getMilestone(int number)
java.util.Map<java.lang.Integer,GHMilestone>	getMilestones() Deprecated. Use listMilestones(GHIssueState)
java.lang.String	getMirrorUrl() Gets the Mirror URL to access this repository: https://github.com/apache/tomee mirrored from git://git.apache.org/tomee.git
java.lang.String	getName() Short repository name without the owner.
int	getNetworkCount()
int	getOpenIssueCount()
GHUser	getOwner()
java.lang.String	getOwnerName()
GHRepository	getParent() Forked repositories have a 'parent' attribute that specifies the repository this repository is directly forked from.
java.util.Set<java.net.URL>	getPostCommitHooks() Deprecated. Use getHooks() and createHook(String, Map, Collection, boolean)
GHPullRequest	getPullRequest(int i) Retrieves a specified pull request.
java.util.List<GHPullRequest>	getPullRequests(GHIssueState state) Retrieves all the pull requests of a particular state.
java.util.Date	getPushedAt()
GHContent	getReadme() https://developer.github.com/v3/repos/contents/#get-the-readme
GHRef	getRef(java.lang.String refName) Retrive a ref of the given type for the current GitHub repository.
GHRef[]	getRefs() Retrieves all refs for the github repository.
GHRef[]	getRefs(java.lang.String refType) Retrieves all refs of the given type for the current GitHub repository.
java.util.List<GHRelease>	getReleases() Deprecated. use listReleases()
int	getSize()
GHRepository	getSource() Forked repositories have a 'source' attribute that specifies the ultimate source of the forking chain.
java.lang.String	getSshUrl() Gets the SSH URL to access this repository, such as git@github.com:rails/rails.git
int	getSubscribersCount()
GHSubscription	getSubscription() Returns the current subscription.
java.lang.String	getSvnUrl() Gets the Subversion URL to access this repository: https://github.com/rails/rails
java.util.Set<GHTeam>	getTeams() If this repository belongs to an organization, return a set of teams.
GHTree	getTree(java.lang.String sha) Retrive a tree of the given type for the current GitHub repository.
GHTree	getTreeRecursive(java.lang.String sha, int recursive) Retrieves the tree for the current GitHub repository, recursively as described in here: https://developer.github.com/v3/git/trees/#get-a-tree-recursively
int	getWatchers()
java.lang.String	gitHttpTransportUrl() Gets the HTTPS URL to this repository, such as "https://github.com/kohsuke/jenkins.git" This URL is read-only.
boolean	hasAdminAccess()
boolean	hasDownloads()
int	hashCode()
boolean	hasIssues()
boolean	hasPullAccess()
boolean	hasPushAccess()
boolean	hasWiki()
boolean	isFork()
boolean	isPrivate()
PagedIterable<GHUser>	listCollaborators() Lists up the collaborators on this repository.
PagedIterable<GHCommitComment>	listCommitComments() Lists up all the commit comments in this repository.
PagedIterable<GHCommit>	listCommits() Lists all the commits.
PagedIterable<GHCommitStatus>	listCommitStatuses(java.lang.String sha1) /** Lists all the commit statues attached to the given commit, newer ones first.
PagedIterable<GHRepository.Contributor>	listContributors()
PagedIterable<GHDeployment>	listDeployments(java.lang.String sha, java.lang.String ref, java.lang.String task, java.lang.String environment)
PagedIterable<GHEventInfo>	listEvents() Lists repository events.
PagedIterable<GHRepository>	listForks() Lists all the direct forks of this repository, sorted by github api default, currently ForkSort.NEWEST.
PagedIterable<GHRepository>	listForks(GHRepository.ForkSort sort) Lists all the direct forks of this repository, sorted by the given sort order.
PagedIterable<GHIssue>	listIssues(GHIssueState state) Lists up all the issues in this repository.
PagedIterable<GHLabel>	listLabels() Lists labels in this repository.
java.util.Map<java.lang.String,java.lang.Long>	listLanguages() List languages for the specified repository.
PagedIterable<GHMilestone>	listMilestones(GHIssueState state) Lists up all the milestones in this repository.
GHNotificationStream	listNotifications() List all the notifications in a repository for the current user.
PagedIterable<GHPullRequest>	listPullRequests(GHIssueState state) Deprecated. Use queryPullRequests()
PagedIterable<GHRelease>	listReleases()
PagedIterable<GHUser>	listStargazers() Lists all the users who have starred this repo based on the old version of the API.
PagedIterable<GHStargazer>	listStargazers2() Lists all the users who have starred this repo based on new version of the API, having extended information like the time when the repository was starred.
PagedIterable<GHUser>	listSubscribers() Lists all the subscribers (aka watchers.) https://developer.github.com/v3/activity/watching/
PagedIterable<GHTag>	listTags()
GHCommitQueryBuilder	queryCommits() Search commits by specifying filters through a builder pattern.
GHPullRequestQueryBuilder	queryPullRequests() Retrieves pull requests.
void	removeCollaborators(java.util.Collection<GHUser> users)
void	removeCollaborators(GHUser... users)
void	renameTo(java.lang.String name) Rename this repository.
java.io.Reader	renderMarkdown(java.lang.String text, MarkdownMode mode) Render a Markdown document.
void	setDefaultBranch(java.lang.String value)
void	setDescription(java.lang.String value)
void	setEmailServiceHook(java.lang.String address)
void	setHomepage(java.lang.String value)
GHSubscription	subscribe(boolean subscribed, boolean ignored) Subscribes to this repository to get notifications.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getUpdatedAt, getUrl, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GHRepository

public GHRepository()

Method Detail

createDeployment

public GHDeploymentBuilder createDeployment(java.lang.String ref)

getDeploymentStatuses

public PagedIterable<GHDeploymentStatus> getDeploymentStatuses(int id)

listDeployments

public PagedIterable<GHDeployment> listDeployments(java.lang.String sha,
                                                   java.lang.String ref,
                                                   java.lang.String task,
                                                   java.lang.String environment)

createDeployStatus

public GHDeploymentStatusBuilder createDeployStatus(int deploymentId,
                                                    GHDeploymentState ghDeploymentState)

getDescription

public java.lang.String getDescription()

getHomepage

public java.lang.String getHomepage()

getGitTransportUrl

public java.lang.String getGitTransportUrl()

Gets the git:// URL to this repository, such as "git://github.com/kohsuke/jenkins.git" This URL is read-only.

gitHttpTransportUrl

public java.lang.String gitHttpTransportUrl()

Gets the HTTPS URL to this repository, such as "https://github.com/kohsuke/jenkins.git" This URL is read-only.

getSvnUrl

public java.lang.String getSvnUrl()

Gets the Subversion URL to access this repository: https://github.com/rails/rails

getMirrorUrl

public java.lang.String getMirrorUrl()

Gets the Mirror URL to access this repository: https://github.com/apache/tomee mirrored from git://git.apache.org/tomee.git

getSshUrl

public java.lang.String getSshUrl()

Gets the SSH URL to access this repository, such as git@github.com:rails/rails.git

getHtmlUrl

public java.net.URL getHtmlUrl()

Description copied from class: GHObject

URL of this object for humans, which renders some HTML.

Specified by:

getHtmlUrl in class GHObject

getName

public java.lang.String getName()

Short repository name without the owner. For example 'jenkins' in case of http://github.com/jenkinsci/jenkins

getFullName

public java.lang.String getFullName()

Full repository name including the owner or organization. For example 'jenkinsci/jenkins' in case of http://github.com/jenkinsci/jenkins

hasPullAccess

public boolean hasPullAccess()

hasPushAccess

public boolean hasPushAccess()

hasAdminAccess

public boolean hasAdminAccess()

getLanguage

public java.lang.String getLanguage()

Gets the primary programming language.

getOwner

public GHUser getOwner()
                throws java.io.IOException

Throws:

java.io.IOException

getIssue

public GHIssue getIssue(int id)
                 throws java.io.IOException

Throws:

java.io.IOException

createIssue

public GHIssueBuilder createIssue(java.lang.String title)

getIssues

public java.util.List<GHIssue> getIssues(GHIssueState state)
                                  throws java.io.IOException

Throws:

java.io.IOException

getIssues

public java.util.List<GHIssue> getIssues(GHIssueState state,
                                         GHMilestone milestone)
                                  throws java.io.IOException

Throws:

java.io.IOException

listIssues

public PagedIterable<GHIssue> listIssues(GHIssueState state)

Lists up all the issues in this repository.

createRelease

public GHReleaseBuilder createRelease(java.lang.String tag)

createRef

public GHRef createRef(java.lang.String name,
                       java.lang.String sha)
                throws java.io.IOException

Creates a named ref, such as tag, branch, etc.

Parameters:

name - The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

sha - The SHA1 value to set this reference to

Throws:

java.io.IOException

getReleases

public java.util.List<GHRelease> getReleases()
                                      throws java.io.IOException

Deprecated. use listReleases()

Throws:

java.io.IOException

listReleases

public PagedIterable<GHRelease> listReleases()
                                      throws java.io.IOException

Throws:

java.io.IOException

listTags

public PagedIterable<GHTag> listTags()
                              throws java.io.IOException

Throws:

java.io.IOException

listLanguages

public java.util.Map<java.lang.String,java.lang.Long> listLanguages()
                                                             throws java.io.IOException

List languages for the specified repository. The value on the right of a language is the number of bytes of code written in that language. { "C": 78769, "Python": 7769 }

Throws:

java.io.IOException

getOwnerName

public java.lang.String getOwnerName()

hasIssues

public boolean hasIssues()

hasWiki

public boolean hasWiki()

isFork

public boolean isFork()

getForks

public int getForks()

Returns the number of all forks of this repository. This not only counts direct forks, but also forks of forks, and so on.

isPrivate

public boolean isPrivate()

hasDownloads

public boolean hasDownloads()

getWatchers

public int getWatchers()

getOpenIssueCount

public int getOpenIssueCount()

getNetworkCount

public int getNetworkCount()

getSubscribersCount

public int getSubscribersCount()

getPushedAt

public java.util.Date getPushedAt()

Returns:

null if the repository was never pushed at.

getDefaultBranch

public java.lang.String getDefaultBranch()

Returns the primary branch you'll configure in the "Admin > Options" config page.

Returns:

This field is null until the user explicitly configures the master branch.

getMasterBranch

public java.lang.String getMasterBranch()

Deprecated. Renamed to getDefaultBranch()

getSize

public int getSize()

getCollaborators

@WithBridgeMethods(value=java.util.Set.class)
public GHPersonSet<GHUser> getCollaborators()
                                                                                   throws java.io.IOException

Gets the collaborators on this repository. This set always appear to include the owner.

Throws:

java.io.IOException

listCollaborators

public PagedIterable<GHUser> listCollaborators()
                                        throws java.io.IOException

Lists up the collaborators on this repository.

Returns:

Users

Throws:

java.io.IOException

getCollaboratorNames

public java.util.Set<java.lang.String> getCollaboratorNames()
                                                     throws java.io.IOException

Gets the names of the collaborators on this repository. This method deviates from the principle of this library but it works a lot faster than getCollaborators().

Throws:

java.io.IOException

getTeams

public java.util.Set<GHTeam> getTeams()
                               throws java.io.IOException

If this repository belongs to an organization, return a set of teams.

Throws:

java.io.IOException

addCollaborators

public void addCollaborators(GHUser... users)
                      throws java.io.IOException

Throws:

java.io.IOException

addCollaborators

public void addCollaborators(java.util.Collection<GHUser> users)
                      throws java.io.IOException

Throws:

java.io.IOException

removeCollaborators

public void removeCollaborators(GHUser... users)
                         throws java.io.IOException

Throws:

java.io.IOException

removeCollaborators

public void removeCollaborators(java.util.Collection<GHUser> users)
                         throws java.io.IOException

Throws:

java.io.IOException

setEmailServiceHook

public void setEmailServiceHook(java.lang.String address)
                         throws java.io.IOException

Throws:

java.io.IOException

enableIssueTracker

public void enableIssueTracker(boolean v)
                        throws java.io.IOException

Enables or disables the issue tracker for this repository.

Throws:

java.io.IOException

enableWiki

public void enableWiki(boolean v)
                throws java.io.IOException

Enables or disables Wiki for this repository.

Throws:

java.io.IOException

enableDownloads

public void enableDownloads(boolean v)
                     throws java.io.IOException

Throws:

java.io.IOException

renameTo

public void renameTo(java.lang.String name)
              throws java.io.IOException

Rename this repository.

Throws:

java.io.IOException

setDescription

public void setDescription(java.lang.String value)
                    throws java.io.IOException

Throws:

java.io.IOException

setHomepage

public void setHomepage(java.lang.String value)
                 throws java.io.IOException

Throws:

java.io.IOException

setDefaultBranch

public void setDefaultBranch(java.lang.String value)
                      throws java.io.IOException

Throws:

java.io.IOException

delete

public void delete()
            throws java.io.IOException

Deletes this repository.

Throws:

java.io.IOException

listForks

public PagedIterable<GHRepository> listForks()

Lists all the direct forks of this repository, sorted by github api default, currently ForkSort.NEWEST.

listForks

public PagedIterable<GHRepository> listForks(GHRepository.ForkSort sort)

Lists all the direct forks of this repository, sorted by the given sort order.

Parameters:

sort - the sort order. If null, defaults to github api default, currently ForkSort.NEWEST.

fork

public GHRepository fork()
                  throws java.io.IOException

Forks this repository as your repository.

Returns:

Newly forked repository that belong to you.

Throws:

java.io.IOException

forkTo

public GHRepository forkTo(GHOrganization org)
                    throws java.io.IOException

Forks this repository into an organization.

Returns:

Newly forked repository that belong to you.

Throws:

java.io.IOException

getPullRequest

public GHPullRequest getPullRequest(int i)
                             throws java.io.IOException

Retrieves a specified pull request.

Throws:

java.io.IOException

getPullRequests

public java.util.List<GHPullRequest> getPullRequests(GHIssueState state)
                                              throws java.io.IOException

Retrieves all the pull requests of a particular state.

Throws:

java.io.IOException

See Also:

listPullRequests(GHIssueState)

listPullRequests

public PagedIterable<GHPullRequest> listPullRequests(GHIssueState state)

Deprecated. Use queryPullRequests()

Retrieves all the pull requests of a particular state.

queryPullRequests

public GHPullRequestQueryBuilder queryPullRequests()

Retrieves pull requests.

createPullRequest

public GHPullRequest createPullRequest(java.lang.String title,
                                       java.lang.String head,
                                       java.lang.String base,
                                       java.lang.String body)
                                throws java.io.IOException

Creates a new pull request.

Parameters:

title - Required. The title of the pull request.

head - Required. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

base - Required. The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.

body - The contents of the pull request. This is the markdown description of a pull request.

Throws:

java.io.IOException

getHooks

public java.util.List<GHHook> getHooks()
                                throws java.io.IOException

Retrieves the currently configured hooks.

Throws:

java.io.IOException

getHook

public GHHook getHook(int id)
               throws java.io.IOException

Throws:

java.io.IOException

getCompare

public GHCompare getCompare(java.lang.String id1,
                            java.lang.String id2)
                     throws java.io.IOException

Gets a comparison between 2 points in the repository. This would be similar to calling git log id1...id2 against a local repository.

Parameters:

id1 - an identifier for the first point to compare from, this can be a sha1 ID (for a commit, tag etc) or a direct tag name

id2 - an identifier for the second point to compare to. Can be the same as the first point.

Returns:

the comparison output

Throws:

java.io.IOException - on failure communicating with GitHub

getCompare

public GHCompare getCompare(GHCommit id1,
                            GHCommit id2)
                     throws java.io.IOException

Throws:

java.io.IOException

getCompare

public GHCompare getCompare(GHBranch id1,
                            GHBranch id2)
                     throws java.io.IOException

Throws:

java.io.IOException

getRefs

public GHRef[] getRefs()
                throws java.io.IOException

Retrieves all refs for the github repository.

Returns:

an array of GHRef elements coresponding with the refs in the remote repository.

Throws:

java.io.IOException - on failure communicating with GitHub

getRefs

public GHRef[] getRefs(java.lang.String refType)
                throws java.io.IOException

Retrieves all refs of the given type for the current GitHub repository.

Parameters:

refType - the type of reg to search for e.g. tags or commits

Returns:

an array of all refs matching the request type

Throws:

java.io.IOException - on failure communicating with GitHub, potentially due to an invalid ref type being requested

getRef

public GHRef getRef(java.lang.String refName)
             throws java.io.IOException

Retrive a ref of the given type for the current GitHub repository.

Parameters:

refName - eg: heads/branch

Returns:

refs matching the request type

Throws:

java.io.IOException - on failure communicating with GitHub, potentially due to an invalid ref type being requested

getTree

public GHTree getTree(java.lang.String sha)
               throws java.io.IOException

Retrive a tree of the given type for the current GitHub repository.

Parameters:

sha - - sha number or branch name ex: "master"

Returns:

refs matching the request type

Throws:

java.io.IOException - on failure communicating with GitHub, potentially due to an invalid tree type being requested

getTreeRecursive

public GHTree getTreeRecursive(java.lang.String sha,
                               int recursive)
                        throws java.io.IOException

Retrieves the tree for the current GitHub repository, recursively as described in here: https://developer.github.com/v3/git/trees/#get-a-tree-recursively

Parameters:

sha - - sha number or branch name ex: "master"

recursive - use 1

Throws:

java.io.IOException - on failure communicating with GitHub, potentially due to an invalid tree type being requested

getCommit

public GHCommit getCommit(java.lang.String sha1)
                   throws java.io.IOException

Gets a commit object in this repository.

Throws:

java.io.IOException

listCommits

public PagedIterable<GHCommit> listCommits()

Lists all the commits.

queryCommits

public GHCommitQueryBuilder queryCommits()

Search commits by specifying filters through a builder pattern.

listCommitComments

public PagedIterable<GHCommitComment> listCommitComments()

Lists up all the commit comments in this repository.

getLicense

@Preview
 @Deprecated
public GHLicense getLicense()
                                           throws java.io.IOException

Deprecated.

Gets the basic license details for the repository.

This is a preview item and subject to change.

Returns:

null if there's no license.

Throws:

java.io.IOException - as usual but also if you don't use the preview connector

getLicenseContent

@Preview
 @Deprecated
public GHContent getLicenseContent()
                                                  throws java.io.IOException

Deprecated.

Retrieves the contents of the repository's license file - makes an additional API call

This is a preview item and subject to change.

Returns:

details regarding the license contents, or null if there's no license.

Throws:

java.io.IOException - as usual but also if you don't use the preview connector

listCommitStatuses

public PagedIterable<GHCommitStatus> listCommitStatuses(java.lang.String sha1)
                                                 throws java.io.IOException

/** Lists all the commit statues attached to the given commit, newer ones first.

Throws:

java.io.IOException

getLastCommitStatus

public GHCommitStatus getLastCommitStatus(java.lang.String sha1)
                                   throws java.io.IOException

Gets the last status of this commit, which is what gets shown in the UI.

Throws:

java.io.IOException

createCommitStatus

public GHCommitStatus createCommitStatus(java.lang.String sha1,
                                         GHCommitState state,
                                         java.lang.String targetUrl,
                                         java.lang.String description,
                                         java.lang.String context)
                                  throws java.io.IOException

Creates a commit status

Parameters:

targetUrl - Optional parameter that points to the URL that has more details.

description - Optional short description.

context - Optinal commit status context.

Throws:

java.io.IOException

createCommitStatus

public GHCommitStatus createCommitStatus(java.lang.String sha1,
                                         GHCommitState state,
                                         java.lang.String targetUrl,
                                         java.lang.String description)
                                  throws java.io.IOException

Throws:

java.io.IOException

See Also:

createCommitStatus(String, GHCommitState,String,String,String)

listEvents

public PagedIterable<GHEventInfo> listEvents()
                                      throws java.io.IOException

Lists repository events.

Throws:

java.io.IOException

listLabels

public PagedIterable<GHLabel> listLabels()
                                  throws java.io.IOException

Lists labels in this repository. https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository

Throws:

java.io.IOException

getLabel

public GHLabel getLabel(java.lang.String name)
                 throws java.io.IOException

Throws:

java.io.IOException

createLabel

public GHLabel createLabel(java.lang.String name,
                           java.lang.String color)
                    throws java.io.IOException

Throws:

java.io.IOException

listSubscribers

public PagedIterable<GHUser> listSubscribers()

Lists all the subscribers (aka watchers.) https://developer.github.com/v3/activity/watching/

listStargazers

public PagedIterable<GHUser> listStargazers()

Lists all the users who have starred this repo based on the old version of the API. For additional information, like date when the repository was starred, see listStargazers2()

listStargazers2

public PagedIterable<GHStargazer> listStargazers2()

Lists all the users who have starred this repo based on new version of the API, having extended information like the time when the repository was starred. For compatibility with the old API see listStargazers()

createHook

public GHHook createHook(java.lang.String name,
                         java.util.Map<java.lang.String,java.lang.String> config,
                         java.util.Collection<GHEvent> events,
                         boolean active)
                  throws java.io.IOException

See https://api.github.com/hooks for possible names and their configuration scheme. TODO: produce type-safe binding

Parameters:

name - Type of the hook to be created. See https://api.github.com/hooks for possible names.

config - The configuration hash.

events - Can be null. Types of events to hook into.

Throws:

java.io.IOException

createWebHook

public GHHook createWebHook(java.net.URL url,
                            java.util.Collection<GHEvent> events)
                     throws java.io.IOException

Throws:

java.io.IOException

createWebHook

public GHHook createWebHook(java.net.URL url)
                     throws java.io.IOException

Throws:

java.io.IOException

getPostCommitHooks

public java.util.Set<java.net.URL> getPostCommitHooks()

Deprecated. Use getHooks() and createHook(String, Map, Collection, boolean)

Returns a set that represents the post-commit hook URLs. The returned set is live, and changes made to them are reflected to GitHub.

getBranches

public java.util.Map<java.lang.String,GHBranch> getBranches()
                                                     throws java.io.IOException

Gets branches by their names.

Throws:

java.io.IOException

getBranch

public GHBranch getBranch(java.lang.String name)
                   throws java.io.IOException

Throws:

java.io.IOException

getMilestones

public java.util.Map<java.lang.Integer,GHMilestone> getMilestones()
                                                           throws java.io.IOException

Deprecated. Use listMilestones(GHIssueState)

Throws:

java.io.IOException

listMilestones

public PagedIterable<GHMilestone> listMilestones(GHIssueState state)

Lists up all the milestones in this repository.

getMilestone

public GHMilestone getMilestone(int number)
                         throws java.io.IOException

Throws:

java.io.IOException

getFileContent

public GHContent getFileContent(java.lang.String path)
                         throws java.io.IOException

Throws:

java.io.IOException

getFileContent

public GHContent getFileContent(java.lang.String path,
                                java.lang.String ref)
                         throws java.io.IOException

Throws:

java.io.IOException

getDirectoryContent

public java.util.List<GHContent> getDirectoryContent(java.lang.String path)
                                              throws java.io.IOException

Throws:

java.io.IOException

getDirectoryContent

public java.util.List<GHContent> getDirectoryContent(java.lang.String path,
                                                     java.lang.String ref)
                                              throws java.io.IOException

Throws:

java.io.IOException

getReadme

public GHContent getReadme()
                    throws java.io.IOException

https://developer.github.com/v3/repos/contents/#get-the-readme

Throws:

java.io.IOException

createContent

public GHContentUpdateResponse createContent(java.lang.String content,
                                             java.lang.String commitMessage,
                                             java.lang.String path)
                                      throws java.io.IOException

Throws:

java.io.IOException

createContent

public GHContentUpdateResponse createContent(java.lang.String content,
                                             java.lang.String commitMessage,
                                             java.lang.String path,
                                             java.lang.String branch)
                                      throws java.io.IOException

Throws:

java.io.IOException

createContent

public GHContentUpdateResponse createContent(byte[] contentBytes,
                                             java.lang.String commitMessage,
                                             java.lang.String path)
                                      throws java.io.IOException

Throws:

java.io.IOException

createContent

public GHContentUpdateResponse createContent(byte[] contentBytes,
                                             java.lang.String commitMessage,
                                             java.lang.String path,
                                             java.lang.String branch)
                                      throws java.io.IOException

Throws:

java.io.IOException

createMilestone

public GHMilestone createMilestone(java.lang.String title,
                                   java.lang.String description)
                            throws java.io.IOException

Throws:

java.io.IOException

addDeployKey

public GHDeployKey addDeployKey(java.lang.String title,
                                java.lang.String key)
                         throws java.io.IOException

Throws:

java.io.IOException

getDeployKeys

public java.util.List<GHDeployKey> getDeployKeys()
                                          throws java.io.IOException

Throws:

java.io.IOException

getSource

public GHRepository getSource()
                       throws java.io.IOException

Forked repositories have a 'source' attribute that specifies the ultimate source of the forking chain.

Returns:

GHRepository that points to the root repository where this repository is forked (indirectly or directly) from. Otherwise null.

Throws:

java.io.IOException

See Also:

getParent()

getParent

public GHRepository getParent()
                       throws java.io.IOException

Forked repositories have a 'parent' attribute that specifies the repository this repository is directly forked from. If we keep traversing getParent() until it returns null, that is getSource().

Returns:

GHRepository that points to the repository where this repository is forked directly from. Otherwise null.

Throws:

java.io.IOException

See Also:

getSource()

subscribe

public GHSubscription subscribe(boolean subscribed,
                                boolean ignored)
                         throws java.io.IOException

Subscribes to this repository to get notifications.

Throws:

java.io.IOException

getSubscription

public GHSubscription getSubscription()
                               throws java.io.IOException

Returns the current subscription.

Returns:

null if no subscription exists.

Throws:

java.io.IOException

listContributors

public PagedIterable<GHRepository.Contributor> listContributors()
                                                         throws java.io.IOException

Throws:

java.io.IOException

renderMarkdown

public java.io.Reader renderMarkdown(java.lang.String text,
                                     MarkdownMode mode)
                              throws java.io.IOException

Render a Markdown document. In GFM mode, issue numbers and user mentions are linked accordingly.

Throws:

java.io.IOException

See Also:

GitHub.renderMarkdown(String)

listNotifications

public GHNotificationStream listNotifications()

List all the notifications in a repository for the current user.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object