plugin/com.vanniktech.maven.publish/MavenPublishBaseExtension

MavenPublishBaseExtension

abstract class MavenPublishBaseExtension @Inject constructor(project: Project, buildEventsListenerRegistry: BuildEventsListenerRegistry, buildFeatures: BuildFeatures)

Constructors

@Inject

constructor(project: Project, buildEventsListenerRegistry: BuildEventsListenerRegistry, buildFeatures: BuildFeatures)

Functions

checksums

fun checksums(vararg checksums: Checksum)

Sets which checksum files are published to Maven Central.

configure

fun configure(platform: Platform)

Configures a Platform which will automatically set up the artifacts that should get published, including javadoc and sources jars depending on the option.

configureBasedOnAppliedPlugins

@Incubating

@JvmOverloads

fun configureBasedOnAppliedPlugins(javadocJar: JavadocJar = defaultJavaDocOption(true), sourcesJar: SourcesJar = SourcesJar.Sources())

@Incubating

fun ~~configureBasedOnAppliedPlugins~~(sourcesJar: Boolean, javadocJar: Boolean)

Calls configure with a Platform chosen based on other applied Gradle plugins.

coordinates

fun coordinates(groupId: String? = null, artifactId: String? = null, version: String? = null)

Set the Maven coordinates consisting of groupId, artifactId and version for this project. In the case of Kotlin Multiplatform projects the given artifactId is used together with the platform targets resulting in artifactIds like [artifactId]-jvm.

excludeSignatureChecksums

@JvmOverloads

fun excludeSignatureChecksums(exclude: Boolean = true)

Controls whether checksum files for signature (.asc) files are excluded when publishing to Maven Central.

pom

fun pom(configure: Action<in MavenPom>)

Configures the POM that will be published.

pomFromGradleProperties

@Incubating

fun pomFromGradleProperties()

Configures the POM through Gradle properties.

publishToMavenCentral

@JvmOverloads

fun publishToMavenCentral(automaticRelease: Boolean = project.automaticRelease(), validateDeployment: DeploymentValidation = project.validateDeployment())

fun ~~publishToMavenCentral~~(automaticRelease: Boolean, validateDeployment: Boolean)

Sets up Maven Central publishing through Sonatype OSSRH by configuring the target repository. Gradle will then automatically create a publishAllPublicationsToMavenCentralRepository task as well as include it in the general publish task.

signAllPublications

fun signAllPublications()

Automatically apply Gradle's signing plugin and configure all publications to be signed. If signing credentials are not configured this will fail the build unless the current version is a SNAPSHOT.