api / org.gradle.api.publish.ivy / IvyPublication

IvyPublication

interface IvyPublication : Publication

A IvyPublication is the representation/configuration of how Gradle should publish something in Ivy format, to an Ivy repository. You directly add a named Ivy Publication the project's publishing.publications container by providing IvyPublication as the type.

 publishing { publications { myPublicationName(IvyPublication) { // Configure the publication here } } }

The Ivy module identifying attributes of the publication are mapped as follows:

module - project.name
organisation - project.group
revision - project.version
status - project.status

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

You can add configurations to the generated ivy descriptor file, by supplying a Closure to the #configurations(org.gradle.api.Action) method.

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 the artifacts to be published.

In addition, IvyModuleDescriptorSpec provides configuration methods to customize licenses, authors, and the description to be published in the Ivy module descriptor.

For any other tweaks to the publication, it is possible to modify the generated Ivy descriptor file prior to publication. This is done using the IvyModuleDescriptorSpec#withXml(org.gradle.api.Action) method, normally via a Closure passed to the #descriptor(org.gradle.api.Action) method.

Example of publishing a java component with an added source jar and custom module description

 apply plugin: "java" apply plugin: "ivy-publish" task sourceJar(type: Jar) { from sourceSets.main.allJava } publishing { publications { myPublication(IvyPublication) { from components.java artifact(sourceJar) { type "source" extension "src.jar" conf "runtime" } descriptor { license { name = "Custom License" } author { name = "Custom Name" } description { text = "Custom Description" } } } } }

Since
1.3

Functions

artifact	`abstract fun artifact(source: Any): IvyArtifact` Creates a custom IvyArtifact to be included in the publication. The `artifact` method can take a variety of input: A org.gradle.api.artifacts.PublishArtifact instance. Name, type, extension and classifier values are taken from the supplied instance. An org.gradle.api.tasks.bundling.AbstractArchiveTask instance. Name, type, extension and classifier values are taken from the supplied instance. Anything that can be resolved to a java.io.File via the `org.gradle.api.Project#file(Object)` method. Name, 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 additional attributes to further configure the constructed artifact. The following example demonstrates the addition of various custom artifacts. `apply plugin: "ivy-publish" task sourceJar(type: Jar) { classifier "source" } task genDocs { doLast { // Generate 'my-docs-file.htm' } } publishing { publications { ivy(IvyPublication) { artifact sourceJar // Publish the output of the sourceJar task artifact 'my-file-name.jar' // Publish a file created outside of the build artifact source: 'my-docs-file.htm', classifier: 'docs', extension: 'html', builtBy: genDocs // Publish a file generated by the 'genDocs' task } } }` `abstract fun artifact(source: Any, config: Action<in IvyArtifact>): IvyArtifact` Creates an IvyArtifact 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 IvyArtifact is then configured using the supplied action. This method also accepts the configure action as a closure argument, by type coercion. `apply plugin: "ivy-publish" task sourceJar(type: Jar) { classifier "source" } task genDocs { doLast { // Generate 'my-docs-file.htm' } } publishing { publications { ivy(IvyPublication) { 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" conf "runtime->default" } artifact("my-docs-file.htm") { type "documentation" extension "html" builtBy genDocs } } } }`
configurations	`abstract fun configurations(config: Action<in IvyConfigurationContainer>): Unit` Defines some IvyConfigurations that should be included in the published ivy module descriptor file. The following example demonstrates how to add a "testCompile" configuration, and a "testRuntime" configuration that extends it. `apply plugin: "java" apply plugin: "ivy-publish" publishing { publications { ivy(IvyPublication) { configurations { testCompile {} testRuntime { extend "testCompile" } } } } }`
descriptor	`abstract fun descriptor(configure: Action<in IvyModuleDescriptorSpec>): Unit` Configures the descriptor that will be published. The descriptor XML can be modified by using the `IvyModuleDescriptorSpec#withXml(org.gradle.api.Action)` method.
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 IvyPublication, only a single component can be provided in this way. The following example demonstrates how to publish the 'java' component to a ivy repository. `apply plugin: "java" apply plugin: "ivy-publish" publishing { publications { ivy(IvyPublication) { from components.java } } }`
getArtifacts	`abstract fun getArtifacts(): IvyArtifactSet` The complete set of artifacts for this publication. Setting this property will clear any previously added artifacts and create 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: "ivy-publish" task sourceJar(type: Jar) { classifier "source" } publishing { publications { ivy(IvyPublication) { from components.java artifacts = ["my-custom-jar.jar", sourceJar] } } }`
getConfigurations	`abstract fun getConfigurations(): IvyConfigurationContainer` Returns the complete set of configurations for this publication.
getDescriptor	`abstract fun getDescriptor(): IvyModuleDescriptorSpec` The module descriptor that will be published.
getModule	`abstract fun getModule(): String` Returns the module for this publication.
getOrganisation	`abstract fun getOrganisation(): String` Returns the organisation for this publication.
getRevision	`abstract fun getRevision(): String` Returns the revision for this publication.
setArtifacts	`abstract fun setArtifacts(sources: MutableIterable<*>): Unit` Sets the artifacts for this publication. Each supplied value is interpreted as per `#artifact(Object)`.
setModule	`abstract fun setModule(module: String): Unit` Sets the module for this publication.
setOrganisation	`abstract fun setOrganisation(organisation: String): Unit` Sets the organisation for this publication.
setRevision	`abstract fun setRevision(revision: String): Unit` Sets the revision for this publication.