Package io.github.cdklabs.projen.release

Class PublisherOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

PublisherOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

PublisherOptions

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

An implementation for PublisherOptions

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

PublisherOptions.Builder, PublisherOptions.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getArtifactName()	(experimental) The name of the artifact to download (e.g.
String	getBuildJobId()	(experimental) The job ID that produces the build artifacts.
String	getCondition()	(experimental) A GitHub workflow expression used as a condition for publishers.
Boolean	getDryRun()	(experimental) Do not actually publish, only print the commands that would be executed instead.
Boolean	getFailureIssue()	(experimental) Create an issue when a publish task fails.
String	getFailureIssueLabel()	(experimental) The label to apply to the issue marking failed publish tasks.
String	getJsiiReleaseVersion()
String	getPublibVersion()	(experimental) Version requirement for publib.
Boolean	getPublishTasks()	(experimental) Define publishing tasks that can be executed manually as well as workflows.
String	getWorkflowContainerImage()	(experimental) Container image to use for GitHub workflows.
String	getWorkflowNodeVersion()	(experimental) Node version to setup in GitHub workflows if any node-based CLI utilities are needed.
List<String>	getWorkflowRunsOn()	(experimental) Github Runner selection labels.
GroupRunnerOptions	getWorkflowRunsOnGroup()	(experimental) Github Runner Group selection options.
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

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(PublisherOptions.Builder builder)

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

Method Detail

getArtifactName

public final String getArtifactName()

Description copied from interface: PublisherOptions

(experimental) The name of the artifact to download (e.g. dist).

The artifact is expected to include a subdirectory for each release target: go (GitHub), dotnet (NuGet), java (Maven), js (npm), python (PyPI).

Specified by:

getArtifactName in interface PublisherOptions

See Also:

https://github.com/aws/publib

getBuildJobId

public final String getBuildJobId()

Description copied from interface: PublisherOptions

(experimental) The job ID that produces the build artifacts.

All publish jobs will take a dependency on this job.

Specified by:

getBuildJobId in interface PublisherOptions

getCondition

public final String getCondition()

Description copied from interface: PublisherOptions

(experimental) A GitHub workflow expression used as a condition for publishers.

Default: - no condition

Specified by:

getCondition in interface PublisherOptions

getDryRun

public final Boolean getDryRun()

Description copied from interface: PublisherOptions

(experimental) Do not actually publish, only print the commands that would be executed instead.

Useful if you wish to block all publishing from a single option.

Specified by:

getDryRun in interface PublisherOptions

getFailureIssue

public final Boolean getFailureIssue()

Description copied from interface: PublisherOptions

(experimental) Create an issue when a publish task fails.

Default: false

Specified by:

getFailureIssue in interface PublisherOptions

getFailureIssueLabel

public final String getFailureIssueLabel()

Description copied from interface: PublisherOptions

(experimental) The label to apply to the issue marking failed publish tasks.

Only applies if failureIssue is true.

Default: "failed-release"

Specified by:

getFailureIssueLabel in interface PublisherOptions

getJsiiReleaseVersion

public final String getJsiiReleaseVersion()

Specified by:

getJsiiReleaseVersion in interface PublisherOptions

getPublibVersion

public final String getPublibVersion()

Description copied from interface: PublisherOptions

(experimental) Version requirement for publib.

Default: "latest"

Specified by:

getPublibVersion in interface PublisherOptions

getPublishTasks

public final Boolean getPublishTasks()

Description copied from interface: PublisherOptions

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

getWorkflowContainerImage

public final String getWorkflowContainerImage()

Description copied from interface: PublisherOptions

(experimental) Container image to use for GitHub workflows.

Default: - default image

Specified by:

getWorkflowContainerImage in interface PublisherOptions

getWorkflowNodeVersion

public final String getWorkflowNodeVersion()

Description copied from interface: PublisherOptions

(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

Specified by:

getWorkflowNodeVersion in interface PublisherOptions

getWorkflowRunsOn

public final List<String> getWorkflowRunsOn()

Description copied from interface: PublisherOptions

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Specified by:

getWorkflowRunsOn in interface PublisherOptions

getWorkflowRunsOnGroup

public final GroupRunnerOptions getWorkflowRunsOnGroup()

Description copied from interface: PublisherOptions

(experimental) Github Runner Group selection options.

Specified by:

getWorkflowRunsOnGroup in interface PublisherOptions

$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