io.github.cdklabs.projen.release

Class MavenPublishOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.MavenPublishOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MavenPublishOptions>

Enclosing interface:

MavenPublishOptions

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

A builder for MavenPublishOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MavenPublishOptions	build() Builds the configured instance.
MavenPublishOptions.Builder	mavenEndpoint(String mavenEndpoint) Sets the value of MavenPublishOptions.getMavenEndpoint()
MavenPublishOptions.Builder	mavenGpgPrivateKeyPassphrase(String mavenGpgPrivateKeyPassphrase) Sets the value of MavenPublishOptions.getMavenGpgPrivateKeyPassphrase()
MavenPublishOptions.Builder	mavenGpgPrivateKeySecret(String mavenGpgPrivateKeySecret) Sets the value of MavenPublishOptions.getMavenGpgPrivateKeySecret()
MavenPublishOptions.Builder	mavenPassword(String mavenPassword) Sets the value of MavenPublishOptions.getMavenPassword()
MavenPublishOptions.Builder	mavenRepositoryUrl(String mavenRepositoryUrl) Sets the value of MavenPublishOptions.getMavenRepositoryUrl()
MavenPublishOptions.Builder	mavenServerId(String mavenServerId) Sets the value of MavenPublishOptions.getMavenServerId()
MavenPublishOptions.Builder	mavenStagingProfileId(String mavenStagingProfileId) Sets the value of MavenPublishOptions.getMavenStagingProfileId()
MavenPublishOptions.Builder	mavenUsername(String mavenUsername) Sets the value of MavenPublishOptions.getMavenUsername()

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

mavenEndpoint

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenEndpoint(String mavenEndpoint)

Sets the value of MavenPublishOptions.getMavenEndpoint()

Parameters:

mavenEndpoint - URL of Nexus repository. if not set, defaults to https://oss.sonatype.org

Returns:

this

mavenGpgPrivateKeyPassphrase

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenGpgPrivateKeyPassphrase(String mavenGpgPrivateKeyPassphrase)

Sets the value of MavenPublishOptions.getMavenGpgPrivateKeyPassphrase()

Parameters:

mavenGpgPrivateKeyPassphrase - GitHub secret name which contains the GPG private key or file that includes it. This is used to sign your Maven packages. See instructions.

Returns:

this

mavenGpgPrivateKeySecret

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenGpgPrivateKeySecret(String mavenGpgPrivateKeySecret)

Sets the value of MavenPublishOptions.getMavenGpgPrivateKeySecret()

Parameters:

mavenGpgPrivateKeySecret - GitHub secret name which contains the GPG private key or file that includes it. This is used to sign your Maven packages. See instructions.

Returns:

this

mavenPassword

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenPassword(String mavenPassword)

Sets the value of MavenPublishOptions.getMavenPassword()

Parameters:

mavenPassword - GitHub secret name which contains the Password for maven repository. For Maven Central, you will need to Create JIRA account and then request a new project (see links).

Returns:

this

mavenRepositoryUrl

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenRepositoryUrl(String mavenRepositoryUrl)

Sets the value of MavenPublishOptions.getMavenRepositoryUrl()

Parameters:

mavenRepositoryUrl - Deployment repository when not deploying to Maven Central.

Returns:

this

mavenServerId

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenServerId(String mavenServerId)

Sets the value of MavenPublishOptions.getMavenServerId()

Parameters:

mavenServerId - Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).

Returns:

this

mavenStagingProfileId

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenStagingProfileId(String mavenStagingProfileId)

Sets the value of MavenPublishOptions.getMavenStagingProfileId()

Parameters:

mavenStagingProfileId - GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).

Returns:

this

mavenUsername

@Stability(value=Experimental)
public MavenPublishOptions.Builder mavenUsername(String mavenUsername)

Sets the value of MavenPublishOptions.getMavenUsername()

Parameters:

mavenUsername - GitHub secret name which contains the Username for maven repository. For Maven Central, you will need to Create JIRA account and then request a new project (see links).

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of MavenPublishOptions

Throws:

NullPointerException - if any required attribute was not provided