org.kohsuke.github

Class GHReleaseBuilder

java.lang.Object

org.kohsuke.github.GHReleaseBuilder

public class GHReleaseBuilder
extends java.lang.Object

Builder pattern for creating a GHRelease

See Also:

GHRepository.createRelease(String)

Constructor Summary

Constructors

Constructor and Description
GHReleaseBuilder(GHRepository ghRepository, java.lang.String tag)

Method Summary

Modifier and Type	Method and Description
GHReleaseBuilder	body(java.lang.String body)
GHReleaseBuilder	commitish(java.lang.String commitish) Specifies the commitish value that determines where the Git tag is created from.
GHRelease	create()
GHReleaseBuilder	draft(boolean draft) Optional.
GHReleaseBuilder	name(java.lang.String name)
GHReleaseBuilder	prerelease(boolean prerelease) Optional

Methods inherited from class java.lang.Object

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

Constructor Detail

GHReleaseBuilder

public GHReleaseBuilder(GHRepository ghRepository,
                        java.lang.String tag)

Method Detail

body

public GHReleaseBuilder body(java.lang.String body)

Parameters:

body - The release notes body.

commitish

public GHReleaseBuilder commitish(java.lang.String commitish)

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA.

Parameters:

commitish - Defaults to the repository’s default branch (usually "master"). Unused if the Git tag already exists.

Returns:

draft

public GHReleaseBuilder draft(boolean draft)

Optional.

Parameters:

draft - true to create a draft (unpublished) release, false to create a published one. Default is false.

name

public GHReleaseBuilder name(java.lang.String name)

Parameters:

name - the name of the release

prerelease

public GHReleaseBuilder prerelease(boolean prerelease)

Optional

Parameters:

prerelease - true to identify the release as a prerelease. false to identify the release as a full release. Default is false.

create

public GHRelease create()
                 throws java.io.IOException

Throws:

java.io.IOException