Package io.github.cdklabs.projen.release

Class PyPiPublishOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.PyPiPublishOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PyPiPublishOptions>

Enclosing interface:

PyPiPublishOptions

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

A builder for PyPiPublishOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PyPiPublishOptions	build()	Builds the configured instance.
PyPiPublishOptions.Builder	postPublishSteps(List<? extends JobStep> postPublishSteps)	Sets the value of CommonPublishOptions.getPostPublishSteps()
PyPiPublishOptions.Builder	prePublishSteps(List<? extends JobStep> prePublishSteps)	Sets the value of CommonPublishOptions.getPrePublishSteps()
PyPiPublishOptions.Builder	publishTools(Tools publishTools)	Sets the value of CommonPublishOptions.getPublishTools()
PyPiPublishOptions.Builder	twinePasswordSecret(String twinePasswordSecret)	Sets the value of PyPiPublishOptions.getTwinePasswordSecret()
PyPiPublishOptions.Builder	twineRegistryUrl(String twineRegistryUrl)	Sets the value of PyPiPublishOptions.getTwineRegistryUrl()
PyPiPublishOptions.Builder	twineUsernameSecret(String twineUsernameSecret)	Sets the value of PyPiPublishOptions.getTwineUsernameSecret()

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

twinePasswordSecret

@Stability(Experimental)
public PyPiPublishOptions.Builder twinePasswordSecret(String twinePasswordSecret)

Sets the value of PyPiPublishOptions.getTwinePasswordSecret()

Parameters:

twinePasswordSecret - The GitHub secret which contains PyPI password.

Returns:

this

twineRegistryUrl

@Stability(Experimental)
public PyPiPublishOptions.Builder twineRegistryUrl(String twineRegistryUrl)

Sets the value of PyPiPublishOptions.getTwineRegistryUrl()

Parameters:

twineRegistryUrl - The registry url to use when releasing packages.

Returns:

this

twineUsernameSecret

@Stability(Experimental)
public PyPiPublishOptions.Builder twineUsernameSecret(String twineUsernameSecret)

Sets the value of PyPiPublishOptions.getTwineUsernameSecret()

Parameters:

twineUsernameSecret - The GitHub secret which contains PyPI user name.

Returns:

this

postPublishSteps

@Stability(Experimental)
public PyPiPublishOptions.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 PyPiPublishOptions.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 PyPiPublishOptions.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 PyPiPublishOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PyPiPublishOptions

Throws:

NullPointerException - if any required attribute was not provided