Package io.github.cdklabs.projen.release

Class NugetPublishOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.NugetPublishOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NugetPublishOptions>

Enclosing interface:

NugetPublishOptions

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

A builder for NugetPublishOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NugetPublishOptions	build()	Builds the configured instance.
NugetPublishOptions.Builder	nugetApiKeySecret(String nugetApiKeySecret)	Sets the value of NugetPublishOptions.getNugetApiKeySecret()
NugetPublishOptions.Builder	nugetServer(String nugetServer)	Sets the value of NugetPublishOptions.getNugetServer()
NugetPublishOptions.Builder	postPublishSteps(List<? extends JobStep> postPublishSteps)	Sets the value of CommonPublishOptions.getPostPublishSteps()
NugetPublishOptions.Builder	prePublishSteps(List<? extends JobStep> prePublishSteps)	Sets the value of CommonPublishOptions.getPrePublishSteps()
NugetPublishOptions.Builder	publishTools(Tools publishTools)	Sets the value of CommonPublishOptions.getPublishTools()

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

nugetApiKeySecret

@Stability(Experimental)
public NugetPublishOptions.Builder nugetApiKeySecret(String nugetApiKeySecret)

Sets the value of NugetPublishOptions.getNugetApiKeySecret()

Parameters:

nugetApiKeySecret - GitHub secret which contains the API key for NuGet.

Returns:

this

nugetServer

@Stability(Experimental)
public NugetPublishOptions.Builder nugetServer(String nugetServer)

Sets the value of NugetPublishOptions.getNugetServer()

Parameters:

nugetServer - NuGet Server URL (defaults to nuget.org).

Returns:

this

postPublishSteps

@Stability(Experimental)
public NugetPublishOptions.Builder postPublishSteps(List<? extends JobStep> postPublishSteps)

Sets the value of CommonPublishOptions.getPostPublishSteps()

Parameters:

postPublishSteps - Steps to execute after executing the publishing command. These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

Returns:

this

prePublishSteps

@Stability(Experimental)
public NugetPublishOptions.Builder prePublishSteps(List<? extends JobStep> prePublishSteps)

Sets the value of CommonPublishOptions.getPrePublishSteps()

Parameters:

prePublishSteps - Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

Returns:

this

publishTools

@Stability(Experimental)
public NugetPublishOptions.Builder publishTools(Tools publishTools)

Sets the value of CommonPublishOptions.getPublishTools()

Parameters:

publishTools - Additional tools to install in the publishing job.

Returns:

this

build

@Stability(Experimental)
public NugetPublishOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NugetPublishOptions

Throws:

NullPointerException - if any required attribute was not provided