api / org.gradle.api.publish.ivy / IvyModuleDescriptorSpec

IvyModuleDescriptorSpec

interface IvyModuleDescriptorSpec

The descriptor of any Ivy publication.

Corresponds to the XML version of the Ivy Module Descriptor.

The #withXml(org.gradle.api.Action) method can be used to modify the descriptor after it has been generated according to the publication data. However, the preferred way to customize the project information to be published is to use the dedicated configuration methods exposed by this class, e.g. #description(Action).

Since
1.3

Functions

author	`abstract fun author(action: Action<in IvyModuleDescriptorAuthor>): Unit` Creates, configures and adds an author to this publication.
description	`abstract fun description(action: Action<in IvyModuleDescriptorDescription>): Unit` Configures the description for this publication.
extraInfo	`abstract fun extraInfo(namespace: String, elementName: String, value: String): Unit` Adds a new extra info element to the publication
getBranch	`abstract fun getBranch(): String` Returns the branch for this publication
getExtraInfo	`abstract fun getExtraInfo(): IvyExtraInfoSpec` Returns the extra info element spec for this publication
getStatus	`abstract fun getStatus(): String` Returns the status for this publication.
license	`abstract fun license(action: Action<in IvyModuleDescriptorLicense>): Unit` Creates, configures and adds a license to this publication.
setBranch	`abstract fun setBranch(branch: String): Unit` Sets the branch for this publication
setStatus	`abstract fun setStatus(status: String): Unit` Sets the status for this publication.
withXml	`abstract fun withXml(action: Action<in XmlProvider>): Unit` Allow configuration of the descriptor, after it has been generated according to the input data. `apply plugin: "ivy-publish" publishing { publications { ivy(IvyPublication) { descriptor { withXml { asNode().dependencies.dependency.find { it.@org == "junit" }.@rev = "4.10" } } } } }` Note that due to Gradle's internal type conversion system, you can pass a Groovy closure to this method and it will be automatically converted to an `Action`. Each action/closure passed to this method will be stored as a callback, and executed when the publication that this descriptor is attached to is published. For details on the structure of the XML to be modified, see the Ivy Module Descriptor reference.