Package io.github.cdklabs.projen

Class VersionOptions.Builder

java.lang.Object

io.github.cdklabs.projen.VersionOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<VersionOptions>

Enclosing interface:

VersionOptions

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

A builder for VersionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VersionOptions.Builder	artifactsDirectory(String artifactsDirectory)	Sets the value of VersionOptions.getArtifactsDirectory()
VersionOptions	build()	Builds the configured instance.
VersionOptions.Builder	releasableCommits(ReleasableCommits releasableCommits)	Sets the value of VersionOptions.getReleasableCommits()
VersionOptions.Builder	tagPrefix(String tagPrefix)	Sets the value of VersionOptions.getTagPrefix()
VersionOptions.Builder	versionInputFile(String versionInputFile)	Sets the value of VersionOptions.getVersionInputFile()
VersionOptions.Builder	versionrcOptions(Map<String,? extends Object> versionrcOptions)	Sets the value of VersionOptions.getVersionrcOptions()

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

artifactsDirectory

@Stability(Experimental)
public VersionOptions.Builder artifactsDirectory(String artifactsDirectory)

Sets the value of VersionOptions.getArtifactsDirectory()

Parameters:

artifactsDirectory - The name of the directory into which changelog.md and version.txt files are emitted. This parameter is required.

Returns:

this

versionInputFile

@Stability(Experimental)
public VersionOptions.Builder versionInputFile(String versionInputFile)

Sets the value of VersionOptions.getVersionInputFile()

Parameters:

versionInputFile - A name of a .json file to set the version field in after a bump. This parameter is required.

Returns:

this

releasableCommits

@Stability(Experimental)
public VersionOptions.Builder releasableCommits(ReleasableCommits releasableCommits)

Sets the value of VersionOptions.getReleasableCommits()

Parameters:

releasableCommits - Find commits that should be considered releasable Used to decide if a release is required.

Returns:

this

tagPrefix

@Stability(Experimental)
public VersionOptions.Builder tagPrefix(String tagPrefix)

Sets the value of VersionOptions.getTagPrefix()

Parameters:

tagPrefix - The tag prefix corresponding to this version.

Returns:

this

versionrcOptions

@Stability(Experimental)
public VersionOptions.Builder versionrcOptions(Map<String,? extends Object> versionrcOptions)

Sets the value of VersionOptions.getVersionrcOptions()

Parameters:

versionrcOptions - Custom configuration for versionrc file used by standard-release.

Returns:

this

build

@Stability(Experimental)
public VersionOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of VersionOptions

Throws:

NullPointerException - if any required attribute was not provided