Named
, Publication
public interface MavenPublication extends Publication
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:
groupId
- project.group
artifactId
- project.name
version
- project.version
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.
apply plugin: "java" apply plugin: "maven-publish" task sourceJar(type: Jar) { from sourceSets.main.allJava archiveClassifier = "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/" } } } } }
Named.Namer
Modifier and Type | Method | Description |
---|---|---|
MavenArtifact |
artifact(Object source) |
Creates a custom
MavenArtifact to be included in the publication. |
MavenArtifact |
artifact(Object source,
Action<? super MavenArtifact> config) |
Creates an
MavenArtifact to be included in the publication, which is configured by the associated action. |
void |
from(SoftwareComponent component) |
Provides the software component that should be published.
|
String |
getArtifactId() |
Returns the artifactId for this publication.
|
MavenArtifactSet |
getArtifacts() |
Returns the complete set of artifacts for this publication.
|
String |
getGroupId() |
Returns the groupId for this publication.
|
MavenPom |
getPom() |
The POM that will be published.
|
String |
getVersion() |
Returns the version for this publication.
|
void |
pom(Action<? super MavenPom> configure) |
Configures the POM that will be published.
|
void |
setArtifactId(String artifactId) |
Sets the artifactId for this publication.
|
void |
setArtifacts(Iterable<?> sources) |
Clears any previously added artifacts from
getArtifacts() and creates artifacts from the specified sources. |
void |
setGroupId(String groupId) |
Sets the groupId for this publication.
|
void |
setVersion(String version) |
Sets the version for this publication.
|
void |
suppressAllPomMetadataWarnings() |
Silences all the compatibility warnings for the Maven publication.
|
void |
suppressPomMetadataWarningsFor(String variantName) |
Silences the compatibility warnings for the Maven publication for the specified variant.
|
void |
versionMapping(Action<? super VersionMappingStrategy> configureAction) |
Configures the version mapping strategy.
|
MavenPom getPom()
void pom(Action<? super MavenPom> configure)
getPom()
result. This method also accepts a closure argument, by type coercion.configure
- The configuration action.void from(SoftwareComponent component)
apply plugin: "java" apply plugin: "maven-publish" publishing { publications { maven(MavenPublication) { from components.java } } }
component
- The software component to publish.MavenArtifact artifact(Object source)
MavenArtifact
to be included in the publication.
The artifact
method can take a variety of input:
PublishArtifact
instance. Extension and classifier values are taken from the wrapped instance.AbstractArchiveTask
instance. Extension and classifier values are taken from the wrapped instance.File
via the Project.file(Object)
method.
Extension and classifier values are interpolated from the file name.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.apply plugin: "maven-publish" task sourceJar(type: Jar) { archiveClassifier = "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' } } }
source
- The source of the artifact content.MavenArtifact artifact(Object source, Action<? super MavenArtifact> config)
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) { archiveClassifier = "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" } } } }
source
- The source of the artifact.config
- An action to configure the values of the constructed MavenArtifact
.void setArtifacts(Iterable<?> sources)
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) { archiveClassifier = "sources" } publishing { publications { maven(MavenPublication) { from components.java artifacts = ["my-custom-jar.jar", sourceJar] } } }
sources
- The set of artifacts for this publication.MavenArtifactSet getArtifacts()
String getGroupId()
void setGroupId(String groupId)
String getArtifactId()
void setArtifactId(String artifactId)
String getVersion()
void setVersion(String version)
void versionMapping(Action<? super VersionMappingStrategy> configureAction)
apply plugin: "java" apply plugin: "maven-publish" publishing { publications { maven(MavenPublication) { from components.java versionMapping { usage('java-runtime'){ fromResolutionResult() } } } } }
configureAction
- the configurationvoid suppressPomMetadataWarningsFor(String variantName)
variantName
- the variant to silence warning forvoid suppressAllPomMetadataWarnings()