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(value=Experimental)
public static final class GitHubReleasesPublishOptions.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubReleasesPublishOptions>

A builder for GitHubReleasesPublishOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GitHubReleasesPublishOptions	build() Builds the configured instance.
GitHubReleasesPublishOptions.Builder	changelogFile(String changelogFile) Sets the value of GitHubReleasesPublishOptions.getChangelogFile()
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(value=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(value=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(value=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

build

@Stability(value=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