io.github.cdklabs.projen.release

Class Release.Builder

java.lang.Object

io.github.cdklabs.projen.release.Release.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Release>

Enclosing class:

Release

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

(experimental) A fluent builder for Release.

Method Summary

Modifier and Type	Method and Description
Release.Builder	antitamper(Boolean antitamper) (experimental) Checks that after build there are no modified files on git.
Release.Builder	artifactsDirectory(String artifactsDirectory) (experimental) A directory which will contain artifacts to be published to npm.
Release.Builder	branch(String branch) (experimental) The default branch name to release from.
Release	build()
static Release.Builder	create(GitHubProject project)
Release.Builder	githubRelease(Boolean githubRelease) (experimental) Create a GitHub release for each release.
Release.Builder	jsiiReleaseVersion(String jsiiReleaseVersion) (experimental) Version requirement of `jsii-release` which is used to publish modules to npm.
Release.Builder	majorVersion(Number majorVersion) (experimental) Major version to release from the default branch.
Release.Builder	npmDistTag(String npmDistTag) (experimental) The npmDistTag to use when publishing from the default branch.
Release.Builder	postBuildSteps(List<? extends JobStep> postBuildSteps) (experimental) Steps to execute after build as part of the release workflow.
Release.Builder	prerelease(String prerelease) (experimental) Bump versions from the default branch as pre-releases (e.g.
Release.Builder	publishTasks(Boolean publishTasks) (experimental) Define publishing tasks that can be executed manually as well as workflows.
Release.Builder	releaseBranches(Map<String,? extends BranchOptions> releaseBranches) (experimental) Defines additional release branches.
Release.Builder	releaseEveryCommit(Boolean releaseEveryCommit) Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead
Release.Builder	releaseFailureIssue(Boolean releaseFailureIssue) (experimental) Create a github issue on every failed publishing task.
Release.Builder	releaseFailureIssueLabel(String releaseFailureIssueLabel) (experimental) The label to apply to issues indicating publish failures.
Release.Builder	releaseSchedule(String releaseSchedule) Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
Release.Builder	releaseTagPrefix(String releaseTagPrefix) (experimental) Automatically add the given prefix to release tags.
Release.Builder	releaseTrigger(ReleaseTrigger releaseTrigger) (experimental) The release trigger to use.
Release.Builder	releaseWorkflowName(String releaseWorkflowName) (experimental) The name of the default release workflow.
Release.Builder	releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps) (experimental) A set of workflow steps to execute in order to setup the workflow container.
Release.Builder	task(Task task) (experimental) The task to execute in order to create the release artifacts.
Release.Builder	versionFile(String versionFile) (experimental) A name of a .json file to set the `version` field in after a bump.
Release.Builder	versionrcOptions(Map<String,? extends Object> versionrcOptions) (experimental) Custom configuration used when creating changelog with standard-version package.
Release.Builder	workflowContainerImage(String workflowContainerImage) (experimental) Container image to use for GitHub workflows.
Release.Builder	workflowRunsOn(List<String> workflowRunsOn) (experimental) Github Runner selection labels.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Release.Builder create(GitHubProject project)

Parameters:

project - This parameter is required.

Returns:

a new instance of Release.Builder.

antitamper

@Stability(value=Experimental)
public Release.Builder antitamper(Boolean antitamper)

(experimental) Checks that after build there are no modified files on git.

Default: true

Parameters:

antitamper - Checks that after build there are no modified files on git. This parameter is required.

Returns:

this

artifactsDirectory

@Stability(value=Experimental)
public Release.Builder artifactsDirectory(String artifactsDirectory)

(experimental) A directory which will contain artifacts to be published to npm.

Default: "dist"

Parameters:

artifactsDirectory - A directory which will contain artifacts to be published to npm. This parameter is required.

Returns:

this

jsiiReleaseVersion

@Stability(value=Experimental)
public Release.Builder jsiiReleaseVersion(String jsiiReleaseVersion)

(experimental) Version requirement of `jsii-release` which is used to publish modules to npm.

Default: "latest"

Parameters:

jsiiReleaseVersion - Version requirement of `jsii-release` which is used to publish modules to npm. This parameter is required.

Returns:

this

majorVersion

@Stability(value=Experimental)
public Release.Builder majorVersion(Number majorVersion)

(experimental) 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.

Default: - Major version is not enforced.

Parameters:

majorVersion - Major version to release from the default branch. This parameter is required.

Returns:

this

npmDistTag

@Stability(value=Experimental)
public Release.Builder npmDistTag(String npmDistTag)

(experimental) 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.

Default: "latest"

Parameters:

npmDistTag - The npmDistTag to use when publishing from the default branch. This parameter is required.

Returns:

this

postBuildSteps

@Stability(value=Experimental)
public Release.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)

(experimental) Steps to execute after build as part of the release workflow.

Default: []

Parameters:

postBuildSteps - Steps to execute after build as part of the release workflow. This parameter is required.

Returns:

this

prerelease

@Stability(value=Experimental)
public Release.Builder prerelease(String prerelease)

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

Default: - normal semantic versions

Parameters:

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

Returns:

this

publishTasks

@Stability(value=Experimental)
public Release.Builder publishTasks(Boolean publishTasks)

(experimental) 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.

Default: false

Parameters:

publishTasks - Define publishing tasks that can be executed manually as well as workflows. This parameter is required.

Returns:

this

releaseBranches

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

(experimental) 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.

Default: - no additional branches are used for release. you can use `addBranch()` to add additional branches.

Parameters:

releaseBranches - Defines additional release branches. This parameter is required.

Returns:

this

releaseEveryCommit

@Stability(value=Deprecated)
 @Deprecated
public Release.Builder releaseEveryCommit(Boolean releaseEveryCommit)

Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead

(deprecated) Automatically release new versions every commit to one of branches in `releaseBranches`.

Default: true

Parameters:

releaseEveryCommit - Automatically release new versions every commit to one of branches in `releaseBranches`. This parameter is required.

Returns:

this

releaseFailureIssue

@Stability(value=Experimental)
public Release.Builder releaseFailureIssue(Boolean releaseFailureIssue)

(experimental) Create a github issue on every failed publishing task.

Default: false

Parameters:

releaseFailureIssue - Create a github issue on every failed publishing task. This parameter is required.

Returns:

this

releaseFailureIssueLabel

@Stability(value=Experimental)
public Release.Builder releaseFailureIssueLabel(String releaseFailureIssueLabel)

(experimental) The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

Default: "failed-release"

Parameters:

releaseFailureIssueLabel - The label to apply to issues indicating publish failures. This parameter is required.

Returns:

this

releaseSchedule

@Stability(value=Deprecated)
 @Deprecated
public Release.Builder releaseSchedule(String releaseSchedule)

Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead

(deprecated) CRON schedule to trigger new releases.

Default: - no scheduled releases

Parameters:

releaseSchedule - CRON schedule to trigger new releases. This parameter is required.

Returns:

this

releaseTagPrefix

@Stability(value=Experimental)
public Release.Builder releaseTagPrefix(String releaseTagPrefix)

(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

Parameters:

releaseTagPrefix - Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. This parameter is required.

Returns:

this

releaseTrigger

@Stability(value=Experimental)
public Release.Builder releaseTrigger(ReleaseTrigger releaseTrigger)

(experimental) The release trigger to use.

Default: - Continuous releases (`ReleaseTrigger.continuous()`)

Parameters:

releaseTrigger - The release trigger to use. This parameter is required.

Returns:

this

releaseWorkflowName

@Stability(value=Experimental)
public Release.Builder releaseWorkflowName(String releaseWorkflowName)

(experimental) The name of the default release workflow.

Default: "Release"

Parameters:

releaseWorkflowName - The name of the default release workflow. This parameter is required.

Returns:

this

releaseWorkflowSetupSteps

@Stability(value=Experimental)
public Release.Builder releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)

(experimental) A set of workflow steps to execute in order to setup the workflow container.

Parameters:

releaseWorkflowSetupSteps - A set of workflow steps to execute in order to setup the workflow container. This parameter is required.

Returns:

this

versionrcOptions

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

(experimental) Custom configuration used when creating changelog with standard-version package.

Given values either append to default configuration or overwrite values in it.

Default: - standard configuration applicable for GitHub repositories

Parameters:

versionrcOptions - Custom configuration used when creating changelog with standard-version package. This parameter is required.

Returns:

this

workflowContainerImage

@Stability(value=Experimental)
public Release.Builder workflowContainerImage(String workflowContainerImage)

(experimental) Container image to use for GitHub workflows.

Default: - default image

Parameters:

workflowContainerImage - Container image to use for GitHub workflows. This parameter is required.

Returns:

this

workflowRunsOn

@Stability(value=Experimental)
public Release.Builder workflowRunsOn(List<String> workflowRunsOn)

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Parameters:

workflowRunsOn - Github Runner selection labels. This parameter is required.

Returns:

this

branch

@Stability(value=Experimental)
public Release.Builder branch(String branch)

(experimental) The default branch name to release from.

Use majorVersion to restrict this branch to only publish releases with a specific major version.

You can add additional branches using addBranch().

Parameters:

branch - The default branch name to release from. This parameter is required.

Returns:

this

task

@Stability(value=Experimental)
public Release.Builder task(Task task)

(experimental) The task to execute in order to create the release artifacts.

Artifacts are expected to reside under artifactsDirectory (defaults to dist/) once build is complete.

Parameters:

task - The task to execute in order to create the release artifacts. This parameter is required.

Returns:

this

versionFile

@Stability(value=Experimental)
public Release.Builder versionFile(String versionFile)

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

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(value=Experimental)
public Release.Builder githubRelease(Boolean githubRelease)

(experimental) Create a GitHub release for each release.

Default: true

Parameters:

githubRelease - Create a GitHub release for each release. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Release build()

Specified by:

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