io.github.cdklabs.projen.release

Interface ReleaseProjectOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, AwsCdkTypeScriptAppOptions, Cdk8sTypeScriptAppOptions, ConstructLibraryAwsOptions, ConstructLibraryCdk8sOptions, ConstructLibraryCdktfOptions, ConstructLibraryOptions, JsiiProjectOptions, NextJsProjectOptions, NextJsTypeScriptProjectOptions, NodeProjectOptions, ReactProjectOptions, ReactTypeScriptProjectOptions, ReleaseOptions, TypeScriptLibraryProjectOptions, TypeScriptProjectOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, AwsCdkTypeScriptAppOptions.Jsii$Proxy, Cdk8sTypeScriptAppOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy, ConstructLibraryCdk8sOptions.Jsii$Proxy, ConstructLibraryCdktfOptions.Jsii$Proxy, ConstructLibraryOptions.Jsii$Proxy, JsiiProjectOptions.Jsii$Proxy, NextJsProjectOptions.Jsii$Proxy, NextJsTypeScriptProjectOptions.Jsii$Proxy, NodeProjectOptions.Jsii$Proxy, ReactProjectOptions.Jsii$Proxy, ReactTypeScriptProjectOptions.Jsii$Proxy, ReleaseOptions.Jsii$Proxy, ReleaseProjectOptions.Jsii$Proxy, TypeScriptLibraryProjectOptions.Jsii$Proxy, TypeScriptProjectOptions.Jsii$Proxy

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

(experimental) Project options for release.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ReleaseProjectOptions.Builder	builder()
default Boolean	getAntitamper() (experimental) Checks that after build there are no modified files on git.
default String	getArtifactsDirectory() (experimental) A directory which will contain artifacts to be published to npm.
default String	getJsiiReleaseVersion() (experimental) Version requirement of `jsii-release` which is used to publish modules to npm.
default Number	getMajorVersion() (experimental) Major version to release from the default branch.
default String	getNpmDistTag() (experimental) The npmDistTag to use when publishing from the default branch.
default List<JobStep>	getPostBuildSteps() (experimental) Steps to execute after build as part of the release workflow.
default String	getPrerelease() (experimental) Bump versions from the default branch as pre-releases (e.g.
default Boolean	getPublishTasks() (experimental) Define publishing tasks that can be executed manually as well as workflows.
default Map<String,BranchOptions>	getReleaseBranches() (experimental) Defines additional release branches.
default Boolean	getReleaseEveryCommit() Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead
default Boolean	getReleaseFailureIssue() (experimental) Create a github issue on every failed publishing task.
default String	getReleaseFailureIssueLabel() (experimental) The label to apply to issues indicating publish failures.
default String	getReleaseSchedule() Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
default String	getReleaseTagPrefix() (experimental) Automatically add the given prefix to release tags.
default ReleaseTrigger	getReleaseTrigger() (experimental) The release trigger to use.
default String	getReleaseWorkflowName() (experimental) The name of the default release workflow.
default List<JobStep>	getReleaseWorkflowSetupSteps() (experimental) A set of workflow steps to execute in order to setup the workflow container.
default Map<String,Object>	getVersionrcOptions() (experimental) Custom configuration used when creating changelog with standard-version package.
default String	getWorkflowContainerImage() (experimental) Container image to use for GitHub workflows.
default List<String>	getWorkflowRunsOn() (experimental) Github Runner selection labels.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAntitamper

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

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

Default: true

getArtifactsDirectory

@Stability(value=Experimental)
 @Nullable
default String getArtifactsDirectory()

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

Default: "dist"

getJsiiReleaseVersion

@Stability(value=Experimental)
 @Nullable
default String getJsiiReleaseVersion()

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

Default: "latest"

getMajorVersion

@Stability(value=Experimental)
 @Nullable
default Number getMajorVersion()

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

getNpmDistTag

@Stability(value=Experimental)
 @Nullable
default String getNpmDistTag()

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

getPostBuildSteps

@Stability(value=Experimental)
 @Nullable
default List<JobStep> getPostBuildSteps()

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

Default: []

getPrerelease

@Stability(value=Experimental)
 @Nullable
default String getPrerelease()

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

Default: - normal semantic versions

getPublishTasks

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

(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

getReleaseBranches

@Stability(value=Experimental)
 @Nullable
default Map<String,BranchOptions> getReleaseBranches()

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

getReleaseEveryCommit

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getReleaseEveryCommit()

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

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

Default: true

getReleaseFailureIssue

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

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

Default: false

getReleaseFailureIssueLabel

@Stability(value=Experimental)
 @Nullable
default String getReleaseFailureIssueLabel()

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

Only applies if releaseFailureIssue is true.

Default: "failed-release"

getReleaseSchedule

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getReleaseSchedule()

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

(deprecated) CRON schedule to trigger new releases.

Default: - no scheduled releases

getReleaseTagPrefix

@Stability(value=Experimental)
 @Nullable
default String getReleaseTagPrefix()

(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

getReleaseTrigger

@Stability(value=Experimental)
 @Nullable
default ReleaseTrigger getReleaseTrigger()

(experimental) The release trigger to use.

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

getReleaseWorkflowName

@Stability(value=Experimental)
 @Nullable
default String getReleaseWorkflowName()

(experimental) The name of the default release workflow.

Default: "Release"

getReleaseWorkflowSetupSteps

@Stability(value=Experimental)
 @Nullable
default List<JobStep> getReleaseWorkflowSetupSteps()

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

getVersionrcOptions

@Stability(value=Experimental)
 @Nullable
default Map<String,Object> getVersionrcOptions()

(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

getWorkflowContainerImage

@Stability(value=Experimental)
 @Nullable
default String getWorkflowContainerImage()

(experimental) Container image to use for GitHub workflows.

Default: - default image

getWorkflowRunsOn

@Stability(value=Experimental)
 @Nullable
default List<String> getWorkflowRunsOn()

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

builder

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

Returns:

a ReleaseProjectOptions.Builder of ReleaseProjectOptions