install

since 1.3

build repository tutorial

Attribute

Description

Required

from

the name of the resolver in which the module must be found

Yes

the name of the resolver in which the module must be installed

Yes

organisation

the name of the organisation of the module to install

Yes

module

the name of the module to install

Yes

branch

the branch of the module to install since 2.0

No, defaults to default branch with exact matcher, '*' with any other matcher

revision

the revision of the module to install

Yes

type

the type(s) of artefact(s) to install. You can give multiple values separated by commas

No, defaults to '*' meaning all types

validate

true to force ivy files validation against ivy.xsd, false to force no validation

No. Defaults to default ivy value (as configured in configuration file)

overwrite

true to override modules already present in the destination resolver, false otherwise

No, defaults to false

transitive

true to install the module and all its transitive dependencies, false to install only the module

No, defaults to false

matcher

the name of the matcher to use to find the modules to install

No, defaults to exact

settingsRef

A reference to the ivy settings that must be used by this task (since 2.0)

No, 'ivy.instance' is taken by default.

haltonfailure

true to fail build on unresolved dependencies since 2.0

No, defaults to true

Attributes

Attribute

Description

Required

organisation

the pattern matching the organisation of the modules to list

Yes

module

the pattern matching the name of the modules to list

Yes

branch

the pattern matching the branch of the modules to list

No, defaults to '*'

revision

the pattern matching the revision of the modules to list

Yes

matcher

the name of the pattern matcher to use for matching the modules fields

No. Defaults to exactOrRegexp.

property

the pattern of the property to set when a module is found

Yes

value

The pattern of the value to set when a module is found

Yes

settingsRef

A reference to the ivy settings that must be used by this task (since 2.0)

No, 'ivy.instance' is taken by default.

resolver

The name of the resolver to use for searching the modules (since 2.2.0)

No, all available resolvers will be used by default.

Attribute

Description

Required

ivyfile

the source ivy file to convert

Yes

pomfile

the destination pom file to write

Yes

settingsRef

A reference to the ivy settings that must be used by this task

No, 'ivy.instance' is taken by default.

Element

Description

Cardinality

mapping

describes the mapping from an Ivy module configuration to a Maven POM scope.
These elements takes two attributes:

conf
scope

0..n

+ + + + + + + + + + + + + + + + + + + + + +

+ +

post resolve tasks

+
Several tasks in Ivy are considered as post resolve task and share a common behaviour and settings accordingly.

These tasks are: +

retrieve
cachefileset
cachepath
artifactproperty (since 2.0)
artifactreport (since 2.0)

+ +All these tasks will trigger automatically a resolve if: +

none has already been called in the current build with the attribute keep set to true (see below)
organisation and module are not set

+ +Since Ivy 1.4, there are two ways to run a resolve: with an ivy file, or with the inline mode.
When you call resolve with an ivy file, the default for it is to keep the resolved data for use by the subsequent post resolve tasks. When you run an inline resolve, the default is not to keep the data. You can override this behaviour by setting the keep attribute as you like.

If you want to to reuse the resolved data obtained through a call to resolve in another build (i.e. not the current one), then you have to set the organisation and module attributes. This work only if the cache was not cleaned since your last resolve call. This does not work with inline calls, which must be performed in the same build.

The attributes listed are then mostly used only if a resolve is triggered automatically.

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + +

Attribute	Description	Required
conf	a comma separated list of the configurations to retrieve or ''. Since 2.0 you can also use '(public)' or '(private)'. Note that '' is interpreted as '*(public)' when inline is true.	No. Defaults to the configurations resolved by the last resolve call, or '*' if no resolve was explicitly called
inline	true to use inline mode, false to resolve an ivy file (since 1.4)	No. defaults false
organisation	the organisation of the module to retrieve. This usually doesn't need to be set since it defaults to the last resolved one, except for inline mode where it is required.	Yes in inline mode, otherwise no, it then defaults to last resolved module name
module	the name of the module to retrieve. This usually doesn't need to be set since it defaults to the last resolved one, except for inline mode where it is required.	Yes in inline mode, otherwise no, it then defaults to last resolved module name
revision	the revision constraint of the module to retrieve. Used only in inline mode. since 1.4	No. Defaults to latest.integration
branch	the name of the branch to resolve in inline mode (since 2.1)	Defaults to no branch in inline mode, nothing in standard mode.
changing	indicates that the module may change when resolving in inline mode. See cache and change management for details. Ignored when resolving in standard mode. (since 2.2.0)	No. Defaults to false.
transitive	true to resolve dependencies transitively, false otherwise since 1.4	No. Defaults to true
resolveMode	the resolve mode to use when an automatic resolve is triggered (since 2.1)	No. defaults to using the resolve mode set in the settings
keep	true to keep the results of the automatic resolve in memory, false to discard them. When this is false, the standard ivy properties won't be set and other postresolve-tasks (like retrieve and cachepath) won't be able to resuse the results of this resolve!	No. defaults to false for an inline resolve and to true in any other case
haltonfailure	true to halt the build on ivy failure, false to continue	No. Defaults to true
validate	true to force ivy files validation against ivy.xsd, false to force no validation	No. Defaults to default ivy value (as configured in configuration file)
refresh	true to force Ivy to resolve dynamic revision in this resolve process, false to use cached resolved revision since 2.1	No. defaults to false
file	the file to resolve if a resolve is necessary since 2.0	No. Defaults to the previous resolved Ivy file or to ${ivy.dep.file}
settingsRef	A reference to the ivy settings that must be used by this task (since 2.0)	No, 'ivy.instance' is taken by default.
resolveId	The id which was used for a previous resolve, or the resolveId if a new resolve is performed (since 2.0)	No, defaults to '[org]-[module]'.
log	the log setting to use during the resolve process. (since 2.0) +Available options are: + default the default log settings, where all usual messages are output to the console + download-only disable all usual messages but download ones. A resolve with everything in cache won't output any message. + quiet disable all usual messages, making the whole resolve process quiet unless errors occur +	No, defaults to 'default'.

Examples

+<ivy:cachepath organisation="emma" module="emma" revision="2.0.4217" inline="true" conf="ant" pathid="emma.classpath"/>
<taskdef resource="emma_ant.properties" classpathref="emma.classpath" /> 
+

+Resolves the emma module in version 2.0.4217, constructs an ant path with the corresponding artifacts, and then define the emma tasks using this path.

+

+ + + + + + + + + +

+ + +

Ivy

install

Examples

Ivy

listmodules

Attributes

Examples

Ivy

makepom

Attributes

Child elements

Examples

Ivy

post resolve tasks

Attributes

Examples