Package io.github.cdklabs.projen.release

Class GitPublishOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.GitPublishOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitPublishOptions>

Enclosing interface:

GitPublishOptions

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

A builder for GitPublishOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitPublishOptions	build()	Builds the configured instance.
GitPublishOptions.Builder	changelogFile(String changelogFile)	Sets the value of GitPublishOptions.getChangelogFile()
GitPublishOptions.Builder	gitBranch(String gitBranch)	Sets the value of GitPublishOptions.getGitBranch()
GitPublishOptions.Builder	gitPushCommand(String gitPushCommand)	Sets the value of GitPublishOptions.getGitPushCommand()
GitPublishOptions.Builder	projectChangelogFile(String projectChangelogFile)	Sets the value of GitPublishOptions.getProjectChangelogFile()
GitPublishOptions.Builder	releaseTagFile(String releaseTagFile)	Sets the value of GitPublishOptions.getReleaseTagFile()
GitPublishOptions.Builder	versionFile(String versionFile)	Sets the value of GitPublishOptions.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 GitPublishOptions.Builder changelogFile(String changelogFile)

Sets the value of GitPublishOptions.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 GitPublishOptions.Builder releaseTagFile(String releaseTagFile)

Sets the value of GitPublishOptions.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 GitPublishOptions.Builder versionFile(String versionFile)

Sets the value of GitPublishOptions.getVersionFile()

Parameters:

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

Returns:

this

gitBranch

@Stability(Experimental)
public GitPublishOptions.Builder gitBranch(String gitBranch)

Sets the value of GitPublishOptions.getGitBranch()

Parameters:

gitBranch - Branch to push to.

Returns:

this

gitPushCommand

@Stability(Experimental)
public GitPublishOptions.Builder gitPushCommand(String gitPushCommand)

Sets the value of GitPublishOptions.getGitPushCommand()

Parameters:

gitPushCommand - Override git-push command. Set to an empty string to disable pushing.

Returns:

this

projectChangelogFile

@Stability(Experimental)
public GitPublishOptions.Builder projectChangelogFile(String projectChangelogFile)

Sets the value of GitPublishOptions.getProjectChangelogFile()

Parameters:

projectChangelogFile - The location of an .md file that includes the project-level changelog.

Returns:

this

build

@Stability(Experimental)
public GitPublishOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GitPublishOptions

Throws:

NullPointerException - if any required attribute was not provided