IvyPublication

API Documentation:IvyPublication

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 (IvyPublication.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 IvyPublication.configurations(org.gradle.api.Action) method.

To add additional artifacts to the set published, use the IvyPublication.artifact(java.lang.Object) and IvyPublication.artifact(java.lang.Object, org.gradle.api.Action) methods. You can also completely replace the set of published artifacts using IvyPublication.setArtifacts(java.lang.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 IvyPublication.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"
        }
      }
    }
  }
}

Properties

PropertyDescription
artifacts

The complete set of artifacts for this publication.

configurations

The complete set of configurations for this publication.

descriptor

The module descriptor that will be published.

module

The module for this publication.

organisation

The organisation for this publication.

revision

The revision for this publication.

Methods

MethodDescription
artifact(source)

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

artifact(source, config)

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 IvyPublication.artifact(java.lang.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.

configurations(config)

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.

descriptor(configure)

Configures the descriptor that will be published.

from(component)

Provides the software component that should be published.

suppressAllIvyMetadataWarnings()

Silences all the compatibility warnings for the Ivy publication. Warnings are emitted when Gradle features are used that cannot be mapped completely to Ivy xml.

suppressIvyMetadataWarningsFor(variantName)

Silences the compatibility warnings for the Ivy publication for the specified variant. Warnings are emitted when Gradle features are used that cannot be mapped completely to Ivy xml.

Script blocks

No script blocks

Property details

IvyArtifactSet artifacts

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 IvyPublication.artifact(java.lang.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) {
  archiveClassifier = "source"
}

publishing {
  publications {
    ivy(IvyPublication) {
      from components.java
      artifacts = ["my-custom-jar.jar", sourceJar]
    }
  }
}

IvyConfigurationContainer configurations (read-only)

The complete set of configurations for this publication.

IvyModuleDescriptorSpec descriptor (read-only)

The module descriptor that will be published.

String module

The module for this publication.

String organisation

The organisation for this publication.

String revision

The revision for this publication.

Method details

IvyArtifact artifact(Object source)

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

  • A PublishArtifact instance. Name, type, extension and classifier values are taken from the supplied instance.
  • An AbstractArchiveTask instance. Name, type, extension and classifier values are taken from the supplied instance.
  • Anything that can be resolved to a File via the Project.file(java.lang.Object) method. Name, extension and classifier values are interpolated from the file name.
  • A 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) {
  archiveClassifier = "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
    }
  }
}

IvyArtifact artifact(Object source, Action<? super IvyArtifact> config)

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 IvyPublication.artifact(java.lang.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) {
  archiveClassifier = "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
      }
    }
  }
}

void configurations(Action<? super IvyConfigurationContainer> config)

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"
          }
      }
    }
  }
}

void descriptor(Action<? super IvyModuleDescriptorSpec> configure)

Configures the descriptor that will be published.

The descriptor XML can be modified by using the IvyModuleDescriptorSpec.withXml(org.gradle.api.Action) method.

void from(SoftwareComponent component)

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
    }
  }
}

void suppressAllIvyMetadataWarnings()

Silences all the compatibility warnings for the Ivy publication. Warnings are emitted when Gradle features are used that cannot be mapped completely to Ivy xml.

void suppressIvyMetadataWarningsFor(String variantName)

Silences the compatibility warnings for the Ivy publication for the specified variant. Warnings are emitted when Gradle features are used that cannot be mapped completely to Ivy xml.