Package 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.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.259Z")
@Stability(Experimental)
public interface ReleaseOptions
extends software.amazon.jsii.JsiiSerializable, ReleaseProjectOptions

(experimental) Options for Release.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReleaseOptions.Builder	builder()
String	getArtifactsDirectory()	(experimental) A directory which will contain build artifacts.
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.
default String	getWorkflowNodeVersion()	(experimental) Node version to setup in GitHub workflows if any node-based CLI utilities are needed.
default JobPermissions	getWorkflowPermissions()	(experimental) Permissions granted to the release workflow job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getJsiiReleaseVersion, getMajorVersion, getMinMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishDryRun, getPublishTasks, getReleasableCommits, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn, getWorkflowRunsOnGroup

Method Detail

getArtifactsDirectory

@Stability(Experimental)
@NotNull
String getArtifactsDirectory()

(experimental) A directory which will contain build artifacts.

Default: "dist"

getBranch

@Stability(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(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(Experimental)
@NotNull
String getVersionFile()

(experimental) A name of a .json file to set the version field in after a bump.

Example:

 "package.json"
 

getGithubRelease

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

(experimental) Create a GitHub release for each release.

Default: true

getWorkflowNodeVersion

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

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

Default: 18.x

getWorkflowPermissions

@Stability(Experimental)
@Nullable
default JobPermissions getWorkflowPermissions()

(experimental) Permissions granted to the release workflow job.

Default: `{ contents: JobPermission.WRITE }`

builder

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

Returns:

a ReleaseOptions.Builder of ReleaseOptions