Package io.github.cdklabs.projen.release

Interface BranchOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BranchOptions.Jsii$Proxy

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

(experimental) Options for a release branch.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BranchOptions.Builder	builder()
Number	getMajorVersion()	(experimental) The major versions released from this branch.
default Number	getMinMajorVersion()	(experimental) The minimum major version to release.
default Number	getMinorVersion()	(experimental) The minor versions released from this branch.
default String	getNpmDistTag()	(experimental) The npm distribution tag to use for this branch.
default String	getPrerelease()	(experimental) Bump the version as a pre-release tag.
default String	getTagPrefix()	(experimental) Automatically add the given prefix to release tags.
default String	getWorkflowName()	(experimental) The name of the release workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMajorVersion

@Stability(Experimental)
@NotNull
Number getMajorVersion()

(experimental) The major versions released from this branch.

getMinMajorVersion

@Stability(Experimental)
@Nullable
default Number getMinMajorVersion()

(experimental) The minimum major version to release.

getMinorVersion

@Stability(Experimental)
@Nullable
default Number getMinorVersion()

(experimental) The minor versions released from this branch.

getNpmDistTag

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

(experimental) The npm distribution tag to use for this branch.

Default: "latest"

getPrerelease

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

(experimental) Bump the version as a pre-release tag.

Default: - normal releases

getTagPrefix

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

(experimental) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.

Default: - no prefix

getWorkflowName

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

(experimental) The name of the release workflow.

Default: "release-BRANCH"

builder

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

Returns:

a BranchOptions.Builder of BranchOptions