Package io.github.cdklabs.projen.release

Interface PyPiPublishOptions

All Superinterfaces:

CommonPublishOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

JsiiPythonTarget, JsiiReleasePyPi

All Known Implementing Classes:

JsiiPythonTarget.Jsii$Proxy, JsiiReleasePyPi.Jsii$Proxy, PyPiPublishOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-01-10T23:18:45.595Z")
@Stability(Experimental)
public interface PyPiPublishOptions
extends software.amazon.jsii.JsiiSerializable, CommonPublishOptions

(experimental) Options for PyPI release.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PyPiPublishOptions.Builder	builder()
default String	getTwinePasswordSecret()	(experimental) The GitHub secret which contains PyPI password.
default String	getTwineRegistryUrl()	(experimental) The registry url to use when releasing packages.
default String	getTwineUsernameSecret()	(experimental) The GitHub secret which contains PyPI user name.

Methods inherited from interface io.github.cdklabs.projen.release.CommonPublishOptions

getPostPublishSteps, getPrePublishSteps, getPublishTools

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTwinePasswordSecret

@Stability(Experimental)
@Nullable
default String getTwinePasswordSecret()

(experimental) The GitHub secret which contains PyPI password.

Default: "TWINE_PASSWORD"

getTwineRegistryUrl

@Stability(Experimental)
@Nullable
default String getTwineRegistryUrl()

(experimental) The registry url to use when releasing packages.

Default: - twine default

getTwineUsernameSecret

@Stability(Experimental)
@Nullable
default String getTwineUsernameSecret()

(experimental) The GitHub secret which contains PyPI user name.

Default: "TWINE_USERNAME"

builder

@Stability(Experimental)
static PyPiPublishOptions.Builder builder()

Returns:

a PyPiPublishOptions.Builder of PyPiPublishOptions