Package io.github.cdklabs.projen.release

Interface MavenPublishOptions

All Superinterfaces:

CommonPublishOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

JsiiJavaTarget, JsiiReleaseMaven

All Known Implementing Classes:

JsiiJavaTarget.Jsii$Proxy, JsiiReleaseMaven.Jsii$Proxy, MavenPublishOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.253Z")
@Stability(Experimental)
public interface MavenPublishOptions
extends software.amazon.jsii.JsiiSerializable, CommonPublishOptions

(experimental) Options for Maven releases.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MavenPublishOptions.Builder	builder()
default String	getMavenEndpoint()	(experimental) URL of Nexus repository.
default String	getMavenGpgPrivateKeyPassphrase()	(experimental) GitHub secret name which contains the GPG private key or file that includes it.
default String	getMavenGpgPrivateKeySecret()	(experimental) GitHub secret name which contains the GPG private key or file that includes it.
default String	getMavenPassword()	(experimental) GitHub secret name which contains the Password for maven repository.
default String	getMavenRepositoryUrl()	(experimental) Deployment repository when not deploying to Maven Central.
default String	getMavenServerId()	(experimental) Used in maven settings for credential lookup (e.g.
default String	getMavenStagingProfileId()	(experimental) GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g.
default String	getMavenUsername()	(experimental) GitHub secret name which contains the Username for maven repository.

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

getMavenEndpoint

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

(experimental) URL of Nexus repository.

if not set, defaults to https://oss.sonatype.org

Default: "https://oss.sonatype.org"

getMavenGpgPrivateKeyPassphrase

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

(experimental) GitHub secret name which contains the GPG private key or file that includes it.

This is used to sign your Maven packages. See instructions.

Default: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages

See Also:

https://github.com/aws/publib#maven

getMavenGpgPrivateKeySecret

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

(experimental) GitHub secret name which contains the GPG private key or file that includes it.

This is used to sign your Maven packages. See instructions.

Default: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages

See Also:

https://github.com/aws/publib#maven

getMavenPassword

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

(experimental) 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).

Default: "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages

See Also:

https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134

getMavenRepositoryUrl

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

(experimental) Deployment repository when not deploying to Maven Central.

Default: - not set

getMavenServerId

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

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

Default: "ossrh" (Maven Central) or "github" when using GitHub Packages

getMavenStagingProfileId

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

(experimental) 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).

Default: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages

getMavenUsername

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

(experimental) 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).

Default: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages

See Also:

https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134

builder

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

Returns:

a MavenPublishOptions.Builder of MavenPublishOptions