Package org.kohsuke.github

Class GHRelease

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHRelease

public class GHRelease
extends GHObject

Release in a github repository.

See Also:

GHRepository#getReleases(), GHRepository#createRelease(String)

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, responseHeaderFields, updated_at, url

Constructor Summary

Constructors

Constructor	Description
GHRelease()

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes this release.
List<GHAsset>	getAssets()	Gets assets.
String	getAssetsUrl()	Gets assets url.
String	getBody()	Gets body.
URL	getHtmlUrl()	Gets html url.
String	getName()	Gets name.
GHRepository	getOwner()	Gets owner.
Date	getPublished_at()	Gets published at.
GitHub	getRoot()	Gets root.
String	getTagName()	Gets tag name.
String	getTarballUrl()	Gets tarball url.
String	getTargetCommitish()	Gets target commitish.
String	getUploadUrl()	Gets upload url.
String	getZipballUrl()	Gets zipball url.
boolean	isDraft()	Is draft boolean.
boolean	isPrerelease()	Is prerelease boolean.
GHRelease	setDraft(boolean draft)	Deprecated. Use update()
void	setName(String name)	Sets name.
void	setOwner(GHRepository owner)	Sets owner.
GHReleaseUpdater	update()	Updates this release via a builder.
GHAsset	uploadAsset(File file, String contentType)	Because github relies on SNI (http://en.wikipedia.org/wiki/Server_Name_Indication) this method will only work on Java 7 or greater.
GHAsset	uploadAsset(String filename, InputStream stream, String contentType)	Upload asset gh asset.

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

GHRelease

public GHRelease()

Method Detail

getAssetsUrl

public String getAssetsUrl()

Gets assets url.

Returns:

the assets url

getBody

public String getBody()

Gets body.

Returns:

the body

isDraft

public boolean isDraft()

Is draft boolean.

Returns:

the boolean

setDraft

public GHRelease setDraft(boolean draft)
                   throws IOException

Deprecated.

Use update()

Sets draft.

Parameters:

draft - the draft

Returns:

the draft

Throws:

IOException - the io exception

getHtmlUrl

public URL getHtmlUrl()

Description copied from class: GHObject

Gets html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

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

getName

public String getName()

Gets name.

Returns:

the name

setName

public void setName(String name)

Sets name.

Parameters:

name - the name

getOwner

public GHRepository getOwner()

Gets owner.

Returns:

the owner

setOwner

public void setOwner(GHRepository owner)

Sets owner.

Parameters:

owner - the owner

isPrerelease

public boolean isPrerelease()

Is prerelease boolean.

Returns:

the boolean

getPublished_at

public Date getPublished_at()

Gets published at.

Returns:

the published at

getRoot

public GitHub getRoot()

Gets root.

Returns:

the root

getTagName

public String getTagName()

Gets tag name.

Returns:

the tag name

getTargetCommitish

public String getTargetCommitish()

Gets target commitish.

Returns:

the target commitish

getUploadUrl

public String getUploadUrl()

Gets upload url.

Returns:

the upload url

getZipballUrl

public String getZipballUrl()

Gets zipball url.

Returns:

the zipball url

getTarballUrl

public String getTarballUrl()

Gets tarball url.

Returns:

the tarball url

uploadAsset

public GHAsset uploadAsset(File file,
                           String contentType)
                    throws IOException

Because github relies on SNI (http://en.wikipedia.org/wiki/Server_Name_Indication) this method will only work on Java 7 or greater. Options for fixing this for earlier JVMs can be found here http://stackoverflow.com/questions/12361090/server-name-indication-sni-on-java but involve more complicated handling of the HTTP requests to github's API.

Parameters:

file - the file

contentType - the content type

Returns:

the gh asset

Throws:

IOException - the io exception

uploadAsset

public GHAsset uploadAsset(String filename,
                           InputStream stream,
                           String contentType)
                    throws IOException

Upload asset gh asset.

Parameters:

filename - the filename

stream - the stream

contentType - the content type

Returns:

the gh asset

Throws:

IOException - the io exception

getAssets

public List<GHAsset> getAssets()
                        throws IOException

Gets assets.

Returns:

the assets

Throws:

IOException - the io exception

delete

public void delete()
            throws IOException

Deletes this release.

Throws:

IOException - the io exception

update

public GHReleaseUpdater update()

Updates this release via a builder.

Returns:

the gh release updater