Package io.github.cdklabs.projen.release

Class ReleaseOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.ReleaseOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ReleaseOptions>

Enclosing interface:

ReleaseOptions

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

A builder for ReleaseOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ReleaseOptions.Builder	artifactsDirectory(String artifactsDirectory)	Sets the value of ReleaseOptions.getArtifactsDirectory()
ReleaseOptions.Builder	branch(String branch)	Sets the value of ReleaseOptions.getBranch()
ReleaseOptions	build()	Builds the configured instance.
ReleaseOptions.Builder	githubRelease(Boolean githubRelease)	Sets the value of ReleaseOptions.getGithubRelease()
ReleaseOptions.Builder	jsiiReleaseVersion(String jsiiReleaseVersion)	Sets the value of ReleaseProjectOptions.getJsiiReleaseVersion()
ReleaseOptions.Builder	majorVersion(Number majorVersion)	Sets the value of ReleaseProjectOptions.getMajorVersion()
ReleaseOptions.Builder	minMajorVersion(Number minMajorVersion)	Sets the value of ReleaseProjectOptions.getMinMajorVersion()
ReleaseOptions.Builder	npmDistTag(String npmDistTag)	Sets the value of ReleaseProjectOptions.getNpmDistTag()
ReleaseOptions.Builder	postBuildSteps(List<? extends JobStep> postBuildSteps)	Sets the value of ReleaseProjectOptions.getPostBuildSteps()
ReleaseOptions.Builder	prerelease(String prerelease)	Sets the value of ReleaseProjectOptions.getPrerelease()
ReleaseOptions.Builder	publishDryRun(Boolean publishDryRun)	Sets the value of ReleaseProjectOptions.getPublishDryRun()
ReleaseOptions.Builder	publishTasks(Boolean publishTasks)	Sets the value of ReleaseProjectOptions.getPublishTasks()
ReleaseOptions.Builder	releasableCommits(ReleasableCommits releasableCommits)	Sets the value of ReleaseProjectOptions.getReleasableCommits()
ReleaseOptions.Builder	releaseBranches(Map<String,? extends BranchOptions> releaseBranches)	Sets the value of ReleaseProjectOptions.getReleaseBranches()
ReleaseOptions.Builder	releaseEveryCommit(Boolean releaseEveryCommit)	Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead
ReleaseOptions.Builder	releaseFailureIssue(Boolean releaseFailureIssue)	Sets the value of ReleaseProjectOptions.getReleaseFailureIssue()
ReleaseOptions.Builder	releaseFailureIssueLabel(String releaseFailureIssueLabel)	Sets the value of ReleaseProjectOptions.getReleaseFailureIssueLabel()
ReleaseOptions.Builder	releaseSchedule(String releaseSchedule)	Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
ReleaseOptions.Builder	releaseTagPrefix(String releaseTagPrefix)	Sets the value of ReleaseProjectOptions.getReleaseTagPrefix()
ReleaseOptions.Builder	releaseTrigger(ReleaseTrigger releaseTrigger)	Sets the value of ReleaseProjectOptions.getReleaseTrigger()
ReleaseOptions.Builder	releaseWorkflowName(String releaseWorkflowName)	Sets the value of ReleaseProjectOptions.getReleaseWorkflowName()
ReleaseOptions.Builder	releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)	Sets the value of ReleaseProjectOptions.getReleaseWorkflowSetupSteps()
ReleaseOptions.Builder	task(Task task)	Sets the value of ReleaseOptions.getTask()
ReleaseOptions.Builder	versionFile(String versionFile)	Sets the value of ReleaseOptions.getVersionFile()
ReleaseOptions.Builder	versionrcOptions(Map<String,? extends Object> versionrcOptions)	Sets the value of ReleaseProjectOptions.getVersionrcOptions()
ReleaseOptions.Builder	workflowContainerImage(String workflowContainerImage)	Sets the value of ReleaseProjectOptions.getWorkflowContainerImage()
ReleaseOptions.Builder	workflowNodeVersion(String workflowNodeVersion)	Sets the value of ReleaseOptions.getWorkflowNodeVersion()
ReleaseOptions.Builder	workflowPermissions(JobPermissions workflowPermissions)	Sets the value of ReleaseOptions.getWorkflowPermissions()
ReleaseOptions.Builder	workflowRunsOn(List<String> workflowRunsOn)	Sets the value of ReleaseProjectOptions.getWorkflowRunsOn()
ReleaseOptions.Builder	workflowRunsOnGroup(GroupRunnerOptions workflowRunsOnGroup)	Sets the value of ReleaseProjectOptions.getWorkflowRunsOnGroup()

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

artifactsDirectory

@Stability(Experimental)
public ReleaseOptions.Builder artifactsDirectory(String artifactsDirectory)

Sets the value of ReleaseOptions.getArtifactsDirectory()

Parameters:

artifactsDirectory - A directory which will contain build artifacts. This parameter is required.

Returns:

this

branch

@Stability(Experimental)
public ReleaseOptions.Builder branch(String branch)

Sets the value of ReleaseOptions.getBranch()

Parameters:

branch - The default branch name to release from. This parameter is required. Use majorVersion to restrict this branch to only publish releases with a specific major version.

You can add additional branches using addBranch().

Returns:

this

task

@Stability(Experimental)
public ReleaseOptions.Builder task(Task task)

Sets the value of ReleaseOptions.getTask()

Parameters:

task - The task to execute in order to create the release artifacts. This parameter is required. Artifacts are expected to reside under artifactsDirectory (defaults to dist/) once build is complete.

Returns:

this

versionFile

@Stability(Experimental)
public ReleaseOptions.Builder versionFile(String versionFile)

Sets the value of ReleaseOptions.getVersionFile()

Parameters:

versionFile - A name of a .json file to set the version field in after a bump. This parameter is required.

Returns:

this

githubRelease

@Stability(Experimental)
public ReleaseOptions.Builder githubRelease(Boolean githubRelease)

Sets the value of ReleaseOptions.getGithubRelease()

Parameters:

githubRelease - Create a GitHub release for each release.

Returns:

this

workflowNodeVersion

@Stability(Experimental)
public ReleaseOptions.Builder workflowNodeVersion(String workflowNodeVersion)

Sets the value of ReleaseOptions.getWorkflowNodeVersion()

Parameters:

workflowNodeVersion - Node version to setup in GitHub workflows if any node-based CLI utilities are needed. For example publib, the CLI projen uses to publish releases, is an npm library.

Returns:

this

workflowPermissions

@Stability(Experimental)
public ReleaseOptions.Builder workflowPermissions(JobPermissions workflowPermissions)

Sets the value of ReleaseOptions.getWorkflowPermissions()

Parameters:

workflowPermissions - Permissions granted to the release workflow job.

Returns:

this

jsiiReleaseVersion

@Stability(Experimental)
public ReleaseOptions.Builder jsiiReleaseVersion(String jsiiReleaseVersion)

Sets the value of ReleaseProjectOptions.getJsiiReleaseVersion()

Parameters:

jsiiReleaseVersion - Version requirement of publib which is used to publish modules to npm.

Returns:

this

majorVersion

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

Sets the value of ReleaseProjectOptions.getMajorVersion()

Parameters:

majorVersion - Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

Returns:

this

minMajorVersion

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

Sets the value of ReleaseProjectOptions.getMinMajorVersion()

Parameters:

minMajorVersion - Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

Can not be set together with majorVersion.

Returns:

this

npmDistTag

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

Sets the value of ReleaseProjectOptions.getNpmDistTag()

Parameters:

npmDistTag - The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

Returns:

this

postBuildSteps

@Stability(Experimental)
public ReleaseOptions.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)

Sets the value of ReleaseProjectOptions.getPostBuildSteps()

Parameters:

postBuildSteps - Steps to execute after build as part of the release workflow.

Returns:

this

prerelease

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

Sets the value of ReleaseProjectOptions.getPrerelease()

Parameters:

prerelease - Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

Returns:

this

publishDryRun

@Stability(Experimental)
public ReleaseOptions.Builder publishDryRun(Boolean publishDryRun)

Sets the value of ReleaseProjectOptions.getPublishDryRun()

Parameters:

publishDryRun - Instead of actually publishing to package managers, just print the publishing command.

Returns:

this

publishTasks

@Stability(Experimental)
public ReleaseOptions.Builder publishTasks(Boolean publishTasks)

Sets the value of ReleaseProjectOptions.getPublishTasks()

Parameters:

publishTasks - Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

Returns:

this

releasableCommits

@Stability(Experimental)
public ReleaseOptions.Builder releasableCommits(ReleasableCommits releasableCommits)

Sets the value of ReleaseProjectOptions.getReleasableCommits()

Parameters:

releasableCommits - Find commits that should be considered releasable Used to decide if a release is required.

Returns:

this

releaseBranches

@Stability(Experimental)
public ReleaseOptions.Builder releaseBranches(Map<String,? extends BranchOptions> releaseBranches)

Sets the value of ReleaseProjectOptions.getReleaseBranches()

Parameters:

releaseBranches - Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

Returns:

this

releaseEveryCommit

@Stability(Deprecated)
@Deprecated
public ReleaseOptions.Builder releaseEveryCommit(Boolean releaseEveryCommit)

Deprecated.

Use `releaseTrigger: ReleaseTrigger.continuous()` instead

Sets the value of ReleaseProjectOptions.getReleaseEveryCommit()

Parameters:

releaseEveryCommit - Automatically release new versions every commit to one of branches in releaseBranches.

Returns:

this

releaseFailureIssue

@Stability(Experimental)
public ReleaseOptions.Builder releaseFailureIssue(Boolean releaseFailureIssue)

Sets the value of ReleaseProjectOptions.getReleaseFailureIssue()

Parameters:

releaseFailureIssue - Create a github issue on every failed publishing task.

Returns:

this

releaseFailureIssueLabel

@Stability(Experimental)
public ReleaseOptions.Builder releaseFailureIssueLabel(String releaseFailureIssueLabel)

Sets the value of ReleaseProjectOptions.getReleaseFailureIssueLabel()

Parameters:

releaseFailureIssueLabel - The label to apply to issues indicating publish failures. Only applies if releaseFailureIssue is true.

Returns:

this

releaseSchedule

@Stability(Deprecated)
@Deprecated
public ReleaseOptions.Builder releaseSchedule(String releaseSchedule)

Deprecated.

Use `releaseTrigger: ReleaseTrigger.scheduled()` instead

Sets the value of ReleaseProjectOptions.getReleaseSchedule()

Parameters:

releaseSchedule - CRON schedule to trigger new releases.

Returns:

this

releaseTagPrefix

@Stability(Experimental)
public ReleaseOptions.Builder releaseTagPrefix(String releaseTagPrefix)

Sets the value of ReleaseProjectOptions.getReleaseTagPrefix()

Parameters:

releaseTagPrefix - 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

releaseTrigger

@Stability(Experimental)
public ReleaseOptions.Builder releaseTrigger(ReleaseTrigger releaseTrigger)

Sets the value of ReleaseProjectOptions.getReleaseTrigger()

Parameters:

releaseTrigger - The release trigger to use.

Returns:

this

releaseWorkflowName

@Stability(Experimental)
public ReleaseOptions.Builder releaseWorkflowName(String releaseWorkflowName)

Sets the value of ReleaseProjectOptions.getReleaseWorkflowName()

Parameters:

releaseWorkflowName - The name of the default release workflow.

Returns:

this

releaseWorkflowSetupSteps

@Stability(Experimental)
public ReleaseOptions.Builder releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)

Sets the value of ReleaseProjectOptions.getReleaseWorkflowSetupSteps()

Parameters:

releaseWorkflowSetupSteps - A set of workflow steps to execute in order to setup the workflow container.

Returns:

this

versionrcOptions

@Stability(Experimental)
public ReleaseOptions.Builder versionrcOptions(Map<String,? extends Object> versionrcOptions)

Sets the value of ReleaseProjectOptions.getVersionrcOptions()

Parameters:

versionrcOptions - Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it.

Returns:

this

workflowContainerImage

@Stability(Experimental)
public ReleaseOptions.Builder workflowContainerImage(String workflowContainerImage)

Sets the value of ReleaseProjectOptions.getWorkflowContainerImage()

Parameters:

workflowContainerImage - Container image to use for GitHub workflows.

Returns:

this

workflowRunsOn

@Stability(Experimental)
public ReleaseOptions.Builder workflowRunsOn(List<String> workflowRunsOn)

Sets the value of ReleaseProjectOptions.getWorkflowRunsOn()

Parameters:

workflowRunsOn - Github Runner selection labels.

Returns:

this

workflowRunsOnGroup

@Stability(Experimental)
public ReleaseOptions.Builder workflowRunsOnGroup(GroupRunnerOptions workflowRunsOnGroup)

Sets the value of ReleaseProjectOptions.getWorkflowRunsOnGroup()

Parameters:

workflowRunsOnGroup - Github Runner Group selection options.

Returns:

this

build

@Stability(Experimental)
public ReleaseOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ReleaseOptions

Throws:

NullPointerException - if any required attribute was not provided