Package io.github.cdklabs.projen.release

Class PublisherOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.PublisherOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PublisherOptions>

Enclosing interface:

PublisherOptions

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

A builder for PublisherOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PublisherOptions.Builder	artifactName(String artifactName)	Sets the value of PublisherOptions.getArtifactName()
PublisherOptions	build()	Builds the configured instance.
PublisherOptions.Builder	buildJobId(String buildJobId)	Sets the value of PublisherOptions.getBuildJobId()
PublisherOptions.Builder	condition(String condition)	Sets the value of PublisherOptions.getCondition()
PublisherOptions.Builder	dryRun(Boolean dryRun)	Sets the value of PublisherOptions.getDryRun()
PublisherOptions.Builder	failureIssue(Boolean failureIssue)	Sets the value of PublisherOptions.getFailureIssue()
PublisherOptions.Builder	failureIssueLabel(String failureIssueLabel)	Sets the value of PublisherOptions.getFailureIssueLabel()
PublisherOptions.Builder	jsiiReleaseVersion(String jsiiReleaseVersion)	Deprecated. use `publibVersion` instead
PublisherOptions.Builder	publibVersion(String publibVersion)	Sets the value of PublisherOptions.getPublibVersion()
PublisherOptions.Builder	publishTasks(Boolean publishTasks)	Sets the value of PublisherOptions.getPublishTasks()
PublisherOptions.Builder	workflowContainerImage(String workflowContainerImage)	Sets the value of PublisherOptions.getWorkflowContainerImage()
PublisherOptions.Builder	workflowNodeVersion(String workflowNodeVersion)	Sets the value of PublisherOptions.getWorkflowNodeVersion()
PublisherOptions.Builder	workflowRunsOn(List<String> workflowRunsOn)	Sets the value of PublisherOptions.getWorkflowRunsOn()
PublisherOptions.Builder	workflowRunsOnGroup(GroupRunnerOptions workflowRunsOnGroup)	Sets the value of PublisherOptions.getWorkflowRunsOnGroup()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

artifactName

@Stability(Experimental)
public PublisherOptions.Builder artifactName(String artifactName)

Sets the value of PublisherOptions.getArtifactName()

Parameters:

artifactName - The name of the artifact to download (e.g. dist). This parameter is required. The artifact is expected to include a subdirectory for each release target: go (GitHub), dotnet (NuGet), java (Maven), js (npm), python (PyPI).

Returns:

this

buildJobId

@Stability(Experimental)
public PublisherOptions.Builder buildJobId(String buildJobId)

Sets the value of PublisherOptions.getBuildJobId()

Parameters:

buildJobId - The job ID that produces the build artifacts. This parameter is required. All publish jobs will take a dependency on this job.

Returns:

this

condition

@Stability(Experimental)
public PublisherOptions.Builder condition(String condition)

Sets the value of PublisherOptions.getCondition()

Parameters:

condition - A GitHub workflow expression used as a condition for publishers.

Returns:

this

dryRun

@Stability(Experimental)
public PublisherOptions.Builder dryRun(Boolean dryRun)

Sets the value of PublisherOptions.getDryRun()

Parameters:

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

Returns:

this

failureIssue

@Stability(Experimental)
public PublisherOptions.Builder failureIssue(Boolean failureIssue)

Sets the value of PublisherOptions.getFailureIssue()

Parameters:

failureIssue - Create an issue when a publish task fails.

Returns:

this

failureIssueLabel

@Stability(Experimental)
public PublisherOptions.Builder failureIssueLabel(String failureIssueLabel)

Sets the value of PublisherOptions.getFailureIssueLabel()

Parameters:

failureIssueLabel - The label to apply to the issue marking failed publish tasks. Only applies if failureIssue is true.

Returns:

this

jsiiReleaseVersion

@Stability(Deprecated)
@Deprecated
public PublisherOptions.Builder jsiiReleaseVersion(String jsiiReleaseVersion)

Deprecated.

use `publibVersion` instead

Sets the value of PublisherOptions.getJsiiReleaseVersion()

Parameters:

jsiiReleaseVersion - the value to be set.

Returns:

this

publibVersion

@Stability(Experimental)
public PublisherOptions.Builder publibVersion(String publibVersion)

Sets the value of PublisherOptions.getPublibVersion()

Parameters:

publibVersion - Version requirement for publib.

Returns:

this

publishTasks

@Stability(Experimental)
public PublisherOptions.Builder publishTasks(Boolean publishTasks)

Sets the value of PublisherOptions.getPublishTasks()

Parameters:

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

Returns:

this

workflowContainerImage

@Stability(Experimental)
public PublisherOptions.Builder workflowContainerImage(String workflowContainerImage)

Sets the value of PublisherOptions.getWorkflowContainerImage()

Parameters:

workflowContainerImage - Container image to use for GitHub workflows.

Returns:

this

workflowNodeVersion

@Stability(Experimental)
public PublisherOptions.Builder workflowNodeVersion(String workflowNodeVersion)

Sets the value of PublisherOptions.getWorkflowNodeVersion()

Parameters:

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

Returns:

this

workflowRunsOn

@Stability(Experimental)
public PublisherOptions.Builder workflowRunsOn(List<String> workflowRunsOn)

Sets the value of PublisherOptions.getWorkflowRunsOn()

Parameters:

workflowRunsOn - Github Runner selection labels.

Returns:

this

workflowRunsOnGroup

@Stability(Experimental)
public PublisherOptions.Builder workflowRunsOnGroup(GroupRunnerOptions workflowRunsOnGroup)

Sets the value of PublisherOptions.getWorkflowRunsOnGroup()

Parameters:

workflowRunsOnGroup - Github Runner Group selection options.

Returns:

this

build

@Stability(Experimental)
public PublisherOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PublisherOptions

Throws:

NullPointerException - if any required attribute was not provided