io.github.cdklabs.projen.release

Class ReleaseProjectOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.release.ReleaseProjectOptions.Jsii$Proxy

All Implemented Interfaces:

ReleaseProjectOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ReleaseProjectOptions

@Stability(value=Experimental)
 @Internal
public static final class ReleaseProjectOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ReleaseProjectOptions

An implementation for ReleaseProjectOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

ReleaseProjectOptions.Builder, ReleaseProjectOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(ReleaseProjectOptions.Builder builder) Constructor that initializes the object based on literal property values passed by the ReleaseProjectOptions.Builder.

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

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

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ReleaseProjectOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the ReleaseProjectOptions.Builder.

Method Detail

getAntitamper

public final Boolean getAntitamper()

Description copied from interface: ReleaseProjectOptions

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

Default: true

Specified by:

getAntitamper in interface ReleaseProjectOptions

getArtifactsDirectory

public final String getArtifactsDirectory()

Description copied from interface: ReleaseProjectOptions

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

Default: "dist"

Specified by:

getArtifactsDirectory in interface ReleaseProjectOptions

getJsiiReleaseVersion

public final String getJsiiReleaseVersion()

Description copied from interface: ReleaseProjectOptions

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

Default: "latest"

Specified by:

getJsiiReleaseVersion in interface ReleaseProjectOptions

getMajorVersion

public final Number getMajorVersion()

Description copied from interface: ReleaseProjectOptions

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

Specified by:

getMajorVersion in interface ReleaseProjectOptions

getNpmDistTag

public final String getNpmDistTag()

Description copied from interface: ReleaseProjectOptions

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

Specified by:

getNpmDistTag in interface ReleaseProjectOptions

getPostBuildSteps

public final List<JobStep> getPostBuildSteps()

Description copied from interface: ReleaseProjectOptions

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

Default: []

Specified by:

getPostBuildSteps in interface ReleaseProjectOptions

getPrerelease

public final String getPrerelease()

Description copied from interface: ReleaseProjectOptions

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

Default: - normal semantic versions

Specified by:

getPrerelease in interface ReleaseProjectOptions

getPublishTasks

public final Boolean getPublishTasks()

Description copied from interface: ReleaseProjectOptions

(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

Specified by:

getPublishTasks in interface ReleaseProjectOptions

getReleaseBranches

public final Map<String,BranchOptions> getReleaseBranches()

Description copied from interface: ReleaseProjectOptions

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

Specified by:

getReleaseBranches in interface ReleaseProjectOptions

getReleaseEveryCommit

public final Boolean getReleaseEveryCommit()

Description copied from interface: ReleaseProjectOptions

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

Default: true

Specified by:

getReleaseEveryCommit in interface ReleaseProjectOptions

getReleaseFailureIssue

public final Boolean getReleaseFailureIssue()

Description copied from interface: ReleaseProjectOptions

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

Default: false

Specified by:

getReleaseFailureIssue in interface ReleaseProjectOptions

getReleaseFailureIssueLabel

public final String getReleaseFailureIssueLabel()

Description copied from interface: ReleaseProjectOptions

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

Only applies if releaseFailureIssue is true.

Default: "failed-release"

Specified by:

getReleaseFailureIssueLabel in interface ReleaseProjectOptions

getReleaseSchedule

public final String getReleaseSchedule()

Description copied from interface: ReleaseProjectOptions

(deprecated) CRON schedule to trigger new releases.

Default: - no scheduled releases

Specified by:

getReleaseSchedule in interface ReleaseProjectOptions

getReleaseTagPrefix

public final String getReleaseTagPrefix()

Description copied from interface: ReleaseProjectOptions

(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

Specified by:

getReleaseTagPrefix in interface ReleaseProjectOptions

getReleaseTrigger

public final ReleaseTrigger getReleaseTrigger()

Description copied from interface: ReleaseProjectOptions

(experimental) The release trigger to use.

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

Specified by:

getReleaseTrigger in interface ReleaseProjectOptions

getReleaseWorkflowName

public final String getReleaseWorkflowName()

Description copied from interface: ReleaseProjectOptions

(experimental) The name of the default release workflow.

Default: "Release"

Specified by:

getReleaseWorkflowName in interface ReleaseProjectOptions

getReleaseWorkflowSetupSteps

public final List<JobStep> getReleaseWorkflowSetupSteps()

Description copied from interface: ReleaseProjectOptions

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

Specified by:

getReleaseWorkflowSetupSteps in interface ReleaseProjectOptions

getVersionrcOptions

public final Map<String,Object> getVersionrcOptions()

Description copied from interface: ReleaseProjectOptions

(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

Specified by:

getVersionrcOptions in interface ReleaseProjectOptions

getWorkflowContainerImage

public final String getWorkflowContainerImage()

Description copied from interface: ReleaseProjectOptions

(experimental) Container image to use for GitHub workflows.

Default: - default image

Specified by:

getWorkflowContainerImage in interface ReleaseProjectOptions

getWorkflowRunsOn

public final List<String> getWorkflowRunsOn()

Description copied from interface: ReleaseProjectOptions

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Specified by:

getWorkflowRunsOn in interface ReleaseProjectOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object