io.github.cdklabs.projen

Interface VersionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VersionOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.456Z")
 @Stability(value=Experimental)
public interface VersionOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for `Version`.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VersionOptions.Builder A builder for VersionOptions
static class	VersionOptions.Jsii$Proxy An implementation for VersionOptions

Method Summary

Modifier and Type	Method and Description
static VersionOptions.Builder	builder()
String	getArtifactsDirectory() (experimental) The name of the directory into which `changelog.md` and `version.txt` files are emitted.
String	getVersionInputFile() (experimental) A name of a .json file to set the `version` field in after a bump.
default Map<String,Object>	getVersionrcOptions() (experimental) Custom configuration for versionrc file used by standard-release.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifactsDirectory

@Stability(value=Experimental)
 @NotNull
String getArtifactsDirectory()

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

getVersionInputFile

@Stability(value=Experimental)
 @NotNull
String getVersionInputFile()

(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"
 

getVersionrcOptions

@Stability(value=Experimental)
 @Nullable
default Map<String,Object> getVersionrcOptions()

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

builder

@Stability(value=Experimental)
static VersionOptions.Builder builder()

Returns:

a VersionOptions.Builder of VersionOptions