io.github.cdklabs.projen.release

Interface ReleaseOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ReleaseProjectOptions

All Known Implementing Classes:

ReleaseOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.925Z")
 @Stability(value=Experimental)
public interface ReleaseOptions
extends software.amazon.jsii.JsiiSerializable, ReleaseProjectOptions

(experimental) Options for `Release`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ReleaseOptions.Builder	builder()
String	getBranch() (experimental) The default branch name to release from.
default Boolean	getGithubRelease() (experimental) Create a GitHub release for each release.
Task	getTask() (experimental) The task to execute in order to create the release artifacts.
String	getVersionFile() (experimental) A name of a .json file to set the `version` field in after a bump.

Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

getAntitamper, getArtifactsDirectory, getJsiiReleaseVersion, getMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishTasks, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBranch

@Stability(value=Experimental)
 @NotNull
String getBranch()

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

getTask

@Stability(value=Experimental)
 @NotNull
Task getTask()

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

getVersionFile

@Stability(value=Experimental)
 @NotNull
String getVersionFile()

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

getGithubRelease

@Stability(value=Experimental)
 @Nullable
default Boolean getGithubRelease()

(experimental) Create a GitHub release for each release.

Default: true

builder

@Stability(value=Experimental)
static ReleaseOptions.Builder builder()

Specified by:

builder in interface ReleaseProjectOptions

Returns:

a ReleaseOptions.Builder of ReleaseOptions