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 forVersionOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VersionOptions.BuilderartifactsDirectory(String artifactsDirectory)Sets the value ofVersionOptions.getArtifactsDirectory()VersionOptionsbuild()Builds the configured instance.VersionOptions.BuilderreleasableCommits(ReleasableCommits releasableCommits)Sets the value ofVersionOptions.getReleasableCommits()VersionOptions.BuildertagPrefix(String tagPrefix)Sets the value ofVersionOptions.getTagPrefix()VersionOptions.BuilderversionInputFile(String versionInputFile)Sets the value ofVersionOptions.getVersionInputFile()VersionOptions.BuilderversionrcOptions(Map<String,? extends Object> versionrcOptions)Sets the value ofVersionOptions.getVersionrcOptions()
-
-
-
Method Detail
-
artifactsDirectory
@Stability(Experimental) public VersionOptions.Builder artifactsDirectory(String artifactsDirectory)
Sets the value ofVersionOptions.getArtifactsDirectory()- Parameters:
artifactsDirectory- The name of the directory into whichchangelog.mdandversion.txtfiles are emitted. This parameter is required.- Returns:
this
-
versionInputFile
@Stability(Experimental) public VersionOptions.Builder versionInputFile(String versionInputFile)
Sets the value ofVersionOptions.getVersionInputFile()- Parameters:
versionInputFile- A name of a .json file to set theversionfield in after a bump. This parameter is required.- Returns:
this
-
releasableCommits
@Stability(Experimental) public VersionOptions.Builder releasableCommits(ReleasableCommits releasableCommits)
Sets the value ofVersionOptions.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 ofVersionOptions.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 ofVersionOptions.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:
buildin interfacesoftware.amazon.jsii.Builder<VersionOptions>- Returns:
- a new instance of
VersionOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-