Package io.github.cdklabs.projen

Interface VersionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VersionOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.817Z")
@Stability(Experimental)
public interface VersionOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for Version.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VersionOptions.Builder	builder()
String	getArtifactsDirectory()	(experimental) The name of the directory into which changelog.md and version.txt files are emitted.
default ReleasableCommits	getReleasableCommits()	(experimental) Find commits that should be considered releasable Used to decide if a release is required.
default String	getTagPrefix()	(experimental) The tag prefix corresponding to this version.
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(Experimental)
@NotNull
String getArtifactsDirectory()

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

getVersionInputFile

@Stability(Experimental)
@NotNull
String getVersionInputFile()

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

Example:

 "package.json"
 

getReleasableCommits

@Stability(Experimental)
@Nullable
default ReleasableCommits getReleasableCommits()

(experimental) Find commits that should be considered releasable Used to decide if a release is required.

Default: ReleasableCommits.everyCommit()

getTagPrefix

@Stability(Experimental)
@Nullable
default String getTagPrefix()

(experimental) The tag prefix corresponding to this version.

getVersionrcOptions

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

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

builder

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

Returns:

a VersionOptions.Builder of VersionOptions