io.github.cdklabs.projen.release

Class Publisher.Builder

java.lang.Object

io.github.cdklabs.projen.release.Publisher.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Publisher>

Enclosing class:

Publisher

@Stability(value=Experimental)
public static final class Publisher.Builder
extends Object
implements software.amazon.jsii.Builder<Publisher>

(experimental) A fluent builder for Publisher.

Method Summary

Modifier and Type	Method and Description
Publisher.Builder	artifactName(String artifactName) (experimental) The name of the artifact to download (e.g.
Publisher	build()
Publisher.Builder	buildJobId(String buildJobId) (experimental) The job ID that produces the build artifacts.
Publisher.Builder	condition(String condition) (experimental) A GitHub workflow expression used as a condition for publishers.
static Publisher.Builder	create(Project project)
Publisher.Builder	failureIssue(Boolean failureIssue) (experimental) Create an issue when a publish task fails.
Publisher.Builder	failureIssueLabel(String failureIssueLabel) (experimental) The label to apply to the issue marking failed publish tasks.
Publisher.Builder	jsiiReleaseVersion(String jsiiReleaseVersion) (experimental) Version requirement for `jsii-release`.
Publisher.Builder	publishTasks(Boolean publishTasks) (experimental) Define publishing tasks that can be executed manually as well as workflows.
Publisher.Builder	workflowRunsOn(List<String> workflowRunsOn) (experimental) Github Runner selection labels.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Publisher.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of Publisher.Builder.

artifactName

@Stability(value=Experimental)
public Publisher.Builder artifactName(String artifactName)

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

Parameters:

artifactName - The name of the artifact to download (e.g. `dist`). This parameter is required.

Returns:

this

See Also:

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

buildJobId

@Stability(value=Experimental)
public Publisher.Builder buildJobId(String buildJobId)

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

All publish jobs will take a dependency on this job.

Parameters:

buildJobId - The job ID that produces the build artifacts. This parameter is required.

Returns:

this

condition

@Stability(value=Experimental)
public Publisher.Builder condition(String condition)

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

Default: - no condition

Parameters:

condition - A GitHub workflow expression used as a condition for publishers. This parameter is required.

Returns:

this

failureIssue

@Stability(value=Experimental)
public Publisher.Builder failureIssue(Boolean failureIssue)

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

Default: false

Parameters:

failureIssue - Create an issue when a publish task fails. This parameter is required.

Returns:

this

failureIssueLabel

@Stability(value=Experimental)
public Publisher.Builder failureIssueLabel(String failureIssueLabel)

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

Only applies if failureIssue is true.

Default: "failed-release"

Parameters:

failureIssueLabel - The label to apply to the issue marking failed publish tasks. This parameter is required.

Returns:

this

jsiiReleaseVersion

@Stability(value=Experimental)
public Publisher.Builder jsiiReleaseVersion(String jsiiReleaseVersion)

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

Default: "latest"

Parameters:

jsiiReleaseVersion - Version requirement for `jsii-release`. This parameter is required.

Returns:

this

publishTasks

@Stability(value=Experimental)
public Publisher.Builder publishTasks(Boolean publishTasks)

(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

Parameters:

publishTasks - Define publishing tasks that can be executed manually as well as workflows. This parameter is required.

Returns:

this

workflowRunsOn

@Stability(value=Experimental)
public Publisher.Builder workflowRunsOn(List<String> workflowRunsOn)

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Parameters:

workflowRunsOn - Github Runner selection labels. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Publisher build()

Specified by:

build in interface software.amazon.jsii.Builder<Publisher>