Package io.github.cdklabs.projen.release

Class GitHubReleasesPublishOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.GitHubReleasesPublishOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubReleasesPublishOptions>

Enclosing interface:

GitHubReleasesPublishOptions

@Stability(Experimental)
public static final class GitHubReleasesPublishOptions.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubReleasesPublishOptions>

A builder for GitHubReleasesPublishOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubReleasesPublishOptions	build()	Builds the configured instance.
GitHubReleasesPublishOptions.Builder	changelogFile(String changelogFile)	Sets the value of GitHubReleasesPublishOptions.getChangelogFile()
GitHubReleasesPublishOptions.Builder	postPublishSteps(List<? extends JobStep> postPublishSteps)	Sets the value of CommonPublishOptions.getPostPublishSteps()
GitHubReleasesPublishOptions.Builder	prePublishSteps(List<? extends JobStep> prePublishSteps)	Sets the value of CommonPublishOptions.getPrePublishSteps()
GitHubReleasesPublishOptions.Builder	publishTools(Tools publishTools)	Sets the value of CommonPublishOptions.getPublishTools()
GitHubReleasesPublishOptions.Builder	releaseTagFile(String releaseTagFile)	Sets the value of GitHubReleasesPublishOptions.getReleaseTagFile()
GitHubReleasesPublishOptions.Builder	versionFile(String versionFile)	Sets the value of GitHubReleasesPublishOptions.getVersionFile()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

changelogFile

@Stability(Experimental)
public GitHubReleasesPublishOptions.Builder changelogFile(String changelogFile)

Sets the value of GitHubReleasesPublishOptions.getChangelogFile()

Parameters:

changelogFile - The location of an .md file (relative to dist/) that includes the changelog for the release. This parameter is required.

Returns:

this

releaseTagFile

@Stability(Experimental)
public GitHubReleasesPublishOptions.Builder releaseTagFile(String releaseTagFile)

Sets the value of GitHubReleasesPublishOptions.getReleaseTagFile()

Parameters:

releaseTagFile - The location of a text file (relative to dist/) that contains the release tag. This parameter is required.

Returns:

this

versionFile

@Stability(Experimental)
public GitHubReleasesPublishOptions.Builder versionFile(String versionFile)

Sets the value of GitHubReleasesPublishOptions.getVersionFile()

Parameters:

versionFile - The location of a text file (relative to dist/) that contains the version number. This parameter is required.

Returns:

this

postPublishSteps

@Stability(Experimental)
public GitHubReleasesPublishOptions.Builder postPublishSteps(List<? extends JobStep> postPublishSteps)

Sets the value of CommonPublishOptions.getPostPublishSteps()

Parameters:

postPublishSteps - Steps to execute after executing the publishing command. These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

Returns:

this

prePublishSteps

@Stability(Experimental)
public GitHubReleasesPublishOptions.Builder prePublishSteps(List<? extends JobStep> prePublishSteps)

Sets the value of CommonPublishOptions.getPrePublishSteps()

Parameters:

prePublishSteps - Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

Returns:

this

publishTools

@Stability(Experimental)
public GitHubReleasesPublishOptions.Builder publishTools(Tools publishTools)

Sets the value of CommonPublishOptions.getPublishTools()

Parameters:

publishTools - Additional tools to install in the publishing job.

Returns:

this

build

@Stability(Experimental)
public GitHubReleasesPublishOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GitHubReleasesPublishOptions>

Returns:

a new instance of GitHubReleasesPublishOptions

Throws:

NullPointerException - if any required attribute was not provided