Package io.github.cdklabs.projen.release

Class BranchOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.BranchOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BranchOptions>

Enclosing interface:

BranchOptions

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

A builder for BranchOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BranchOptions	build()	Builds the configured instance.
BranchOptions.Builder	majorVersion(Number majorVersion)	Sets the value of BranchOptions.getMajorVersion()
BranchOptions.Builder	minMajorVersion(Number minMajorVersion)	Sets the value of BranchOptions.getMinMajorVersion()
BranchOptions.Builder	minorVersion(Number minorVersion)	Sets the value of BranchOptions.getMinorVersion()
BranchOptions.Builder	npmDistTag(String npmDistTag)	Sets the value of BranchOptions.getNpmDistTag()
BranchOptions.Builder	prerelease(String prerelease)	Sets the value of BranchOptions.getPrerelease()
BranchOptions.Builder	tagPrefix(String tagPrefix)	Sets the value of BranchOptions.getTagPrefix()
BranchOptions.Builder	workflowName(String workflowName)	Sets the value of BranchOptions.getWorkflowName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

majorVersion

@Stability(Experimental)
public BranchOptions.Builder majorVersion(Number majorVersion)

Sets the value of BranchOptions.getMajorVersion()

Parameters:

majorVersion - The major versions released from this branch. This parameter is required.

Returns:

this

minMajorVersion

@Stability(Experimental)
public BranchOptions.Builder minMajorVersion(Number minMajorVersion)

Sets the value of BranchOptions.getMinMajorVersion()

Parameters:

minMajorVersion - The minimum major version to release.

Returns:

this

minorVersion

@Stability(Experimental)
public BranchOptions.Builder minorVersion(Number minorVersion)

Sets the value of BranchOptions.getMinorVersion()

Parameters:

minorVersion - The minor versions released from this branch.

Returns:

this

npmDistTag

@Stability(Experimental)
public BranchOptions.Builder npmDistTag(String npmDistTag)

Sets the value of BranchOptions.getNpmDistTag()

Parameters:

npmDistTag - The npm distribution tag to use for this branch.

Returns:

this

prerelease

@Stability(Experimental)
public BranchOptions.Builder prerelease(String prerelease)

Sets the value of BranchOptions.getPrerelease()

Parameters:

prerelease - Bump the version as a pre-release tag.

Returns:

this

tagPrefix

@Stability(Experimental)
public BranchOptions.Builder tagPrefix(String tagPrefix)

Sets the value of BranchOptions.getTagPrefix()

Parameters:

tagPrefix - 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.

Returns:

this

workflowName

@Stability(Experimental)
public BranchOptions.Builder workflowName(String workflowName)

Sets the value of BranchOptions.getWorkflowName()

Parameters:

workflowName - The name of the release workflow.

Returns:

this

build

@Stability(Experimental)
public BranchOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BranchOptions

Throws:

NullPointerException - if any required attribute was not provided