api / org.gradle.api.publish.maven / MavenPublication

MavenPublication

interface MavenPublication : Publication

A MavenPublication is the representation/configuration of how Gradle should publish something in Maven format. You directly add a named Maven Publication the project's publishing.publications container by providing MavenPublication as the type. 

 publishing { publications { myPublicationName(MavenPublication) { // Configure the publication here } } }
The default Maven POM identifying attributes are mapped as follows:

For certain common use cases, it's often sufficient to specify the component to publish, and nothing more (#from(org.gradle.api.component.SoftwareComponent). The published component is used to determine which artifacts to publish, and which dependencies should be listed in the generated POM file.

To add additional artifacts to the set published, use the #artifact(Object) and #artifact(Object, org.gradle.api.Action) methods. You can also completely replace the set of published artifacts using #setArtifacts(Iterable). Together, these methods give you full control over what artifacts will be published.

To customize the metadata published in the generated POM, set properties, e.g. MavenPom#getDescription(), on the POM returned via the #getPom() method or directly by an action (or closure) passed into #pom(org.gradle.api.Action). As a last resort, it is possible to modify the generated POM using the MavenPom#withXml(org.gradle.api.Action) method.

Example of publishing a Java module with a source artifact and a customized POM 
 apply plugin: "java" apply plugin: "maven-publish" task sourceJar(type: Jar) { from sourceSets.main.allJava classifier "sources" } publishing { publications { myPublication(MavenPublication) { from components.java artifact sourceJar pom { name = "Demo" description = "A demonstration of Maven POM customization" url = "http://www.example.com/project" licenses { license { name = "The Apache License, Version 2.0" url = "http://www.apache.org/licenses/LICENSE-2.0.txt" } } developers { developer { id = "johnd" name = "John Doe" email = "john.doe@example.com" } } scm { connection = "scm:svn:http://subversion.example.com/svn/project/trunk/" developerConnection = "scm:svn:https://subversion.example.com/svn/project/trunk/" url = "http://subversion.example.com/svn/project/trunk/" } } } } }

Since
1.4

Functions

artifact

 abstract fun artifact(source: Any): MavenArtifact

Creates a custom MavenArtifact to be included in the publication. The artifact method can take a variety of input:

  • A org.gradle.api.artifacts.PublishArtifact instance. Extension and classifier values are taken from the wrapped instance.
  • An org.gradle.api.tasks.bundling.AbstractArchiveTask instance. Extension and classifier values are taken from the wrapped instance.
  • Anything that can be resolved to a java.io.File via the org.gradle.api.Project#file(Object) method. Extension and classifier values are interpolated from the file name.
  • A java.util.Map that contains a 'source' entry that can be resolved as any of the other input types, including file. This map can contain a 'classifier' and an 'extension' entry to further configure the constructed artifact.
The following example demonstrates the addition of various custom artifacts. 
 apply plugin: "maven-publish" task sourceJar(type: Jar) { classifier "sources" } publishing { publications { maven(MavenPublication) { artifact sourceJar // Publish the output of the sourceJar task artifact 'my-file-name.jar' // Publish a file created outside of the build artifact source: sourceJar, classifier: 'src', extension: 'zip' } } }

abstract fun artifact(source: Any, config: Action<in MavenArtifact>): MavenArtifact

Creates an MavenArtifact to be included in the publication, which is configured by the associated action. The first parameter is used to create a custom artifact and add it to the publication, as per #artifact(Object). The created MavenArtifact is then configured using the supplied action, which can override the extension or classifier of the artifact. This method also accepts the configure action as a closure argument, by type coercion. 

 apply plugin: "maven-publish" task sourceJar(type: Jar) { classifier "sources" } publishing { publications { maven(MavenPublication) { artifact(sourceJar) { // These values will be used instead of the values from the task. The task values will not be updated. classifier "src" extension "zip" } artifact("my-docs-file.htm") { classifier "documentation" extension "html" } } } }

from

 abstract fun from(component: SoftwareComponent): Unit

Provides the software component that should be published.

  • Any artifacts declared by the component will be included in the publication.
  • The dependencies declared by the component will be included in the published meta-data.
Currently 2 types of component are supported: 'components.java' (added by the JavaPlugin) and 'components.web' (added by the WarPlugin). For any individual MavenPublication, only a single component can be provided in this way. The following example demonstrates how to publish the 'java' component to a Maven repository. 
 apply plugin: "java" apply plugin: "maven-publish" publishing { publications { maven(MavenPublication) { from components.java } } }

getArtifactId

 abstract fun getArtifactId(): String

Returns the artifactId for this publication.

getArtifacts

 abstract fun getArtifacts(): MavenArtifactSet

Returns the complete set of artifacts for this publication.

getGroupId

 abstract fun getGroupId(): String

Returns the groupId for this publication.

getPom

 abstract fun getPom(): MavenPom

The POM that will be published.

getVersion

 abstract fun getVersion(): String

Returns the version for this publication.

pom

 abstract fun pom(configure: Action<in MavenPom>): Unit

Configures the POM that will be published. The supplied action will be executed against the #getPom() result. This method also accepts a closure argument, by type coercion.

setArtifactId

 abstract fun setArtifactId(artifactId: String): Unit

Sets the artifactId for this publication.

setArtifacts

 abstract fun setArtifacts(sources: MutableIterable<*>): Unit

Clears any previously added artifacts from #getArtifacts and creates artifacts from the specified sources. Each supplied source is interpreted as per #artifact(Object). For example, to exclude the dependencies declared by a component and instead use a custom set of artifacts: 

 apply plugin: "java" apply plugin: "maven-publish" task sourceJar(type: Jar) { classifier "sources" } publishing { publications { maven(MavenPublication) { from components.java artifacts = ["my-custom-jar.jar", sourceJar] } } }

setGroupId

 abstract fun setGroupId(groupId: String): Unit

Sets the groupId for this publication.

setVersion

 abstract fun setVersion(version: String): Unit

Sets the version for this publication.