io.github.cdklabs.projen

Class Version.Builder

java.lang.Object

io.github.cdklabs.projen.Version.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Version>

Enclosing class:

Version

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

(experimental) A fluent builder for Version.

Method Summary

Modifier and Type	Method and Description
Version.Builder	artifactsDirectory(String artifactsDirectory) (experimental) The name of the directory into which `changelog.md` and `version.txt` files are emitted.
Version	build()
static Version.Builder	create(Project project)
Version.Builder	versionInputFile(String versionInputFile) (experimental) A name of a .json file to set the `version` field in after a bump.
Version.Builder	versionrcOptions(Map<String,? extends Object> versionrcOptions) (experimental) Custom configuration for versionrc file used by standard-release.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Version.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of Version.Builder.

artifactsDirectory

@Stability(value=Experimental)
public Version.Builder artifactsDirectory(String artifactsDirectory)

(experimental) The name of the directory into which `changelog.md` and `version.txt` files are emitted.

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(value=Experimental)
public Version.Builder versionInputFile(String versionInputFile)

(experimental) A name of a .json file to set the `version` field in after a bump.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "package.json"
 

Parameters:

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

Returns:

this

versionrcOptions

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

(experimental) Custom configuration for versionrc file used by standard-release.

Parameters:

versionrcOptions - Custom configuration for versionrc file used by standard-release. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Version build()

Specified by:

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