io.github.cdklabs.projen.release

Interface PublisherOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PublisherOptions.Jsii$Proxy

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

(experimental) Options for `Publisher`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static PublisherOptions.Builder	builder()
String	getArtifactName() (experimental) The name of the artifact to download (e.g.
String	getBuildJobId() (experimental) The job ID that produces the build artifacts.
default String	getCondition() (experimental) A GitHub workflow expression used as a condition for publishers.
default Boolean	getFailureIssue() (experimental) Create an issue when a publish task fails.
default String	getFailureIssueLabel() (experimental) The label to apply to the issue marking failed publish tasks.
default String	getJsiiReleaseVersion() (experimental) Version requirement for `jsii-release`.
default Boolean	getPublishTasks() (experimental) Define publishing tasks that can be executed manually as well as workflows.
default List<String>	getWorkflowRunsOn() (experimental) Github Runner selection labels.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifactName

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

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

See Also:

https://github.com/aws/jsii-release

getBuildJobId

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

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

All publish jobs will take a dependency on this job.

getCondition

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

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

Default: - no condition

getFailureIssue

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

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

Default: false

getFailureIssueLabel

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

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

Only applies if failureIssue is true.

Default: "failed-release"

getJsiiReleaseVersion

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

(experimental) Version requirement for `jsii-release`.

Default: "latest"

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

getWorkflowRunsOn

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

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

builder

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

Returns:

a PublisherOptions.Builder of PublisherOptions