Package org.kohsuke.github

Class GHReleaseUpdater

java.lang.Object

org.kohsuke.github.GHReleaseUpdater

public class GHReleaseUpdater
extends Object

Modifies GHRelease.

Author:

Kohsuke Kawaguchi

See Also:

GHRelease#update()

Method Summary

Modifier and Type	Method	Description
GHReleaseUpdater	body(String body)	Body gh release updater.
GHReleaseUpdater	categoryName(String categoryName)	Optional.
GHReleaseUpdater	commitish(String commitish)	Specifies the commitish value that determines where the Git tag is created from.
GHReleaseUpdater	draft(boolean draft)	Optional.
GHReleaseUpdater	name(String name)	Name gh release updater.
GHReleaseUpdater	prerelease(boolean prerelease)	Optional.
GHReleaseUpdater	tag(String tag)	Tag gh release updater.
GHRelease	update()	Update gh release.

Methods inherited from class java.lang.Object

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

Method Detail

tag

public GHReleaseUpdater tag(String tag)

Tag gh release updater.

Parameters:

tag - the tag

Returns:

the gh release updater

body

public GHReleaseUpdater body(String body)

Body gh release updater.

Parameters:

body - The release notes body.

Returns:

the gh release updater

commitish

public GHReleaseUpdater commitish(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 "main"). Unused if the Git tag already exists.

Returns:

the gh release updater

draft

public GHReleaseUpdater draft(boolean draft)

Optional.

Parameters:

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

Returns:

the gh release updater

name

public GHReleaseUpdater name(String name)

Name gh release updater.

Parameters:

name - the name of the release

Returns:

the gh release updater

prerelease

public GHReleaseUpdater 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.

Returns:

the gh release updater

categoryName

public GHReleaseUpdater categoryName(String categoryName)

Optional.

Parameters:

categoryName - the category of the discussion to be created for the release. Category should already exist

Returns:

the gh release builder

update

public GHRelease update()
                 throws IOException

Update gh release.

Returns:

the gh release

Throws:

IOException - the io exception