settings


Tag: settings

Configures some important ivy info: default cache, default resolver, ...

Default cache is the default directory used for both the resolution and repository cache(s). It usually points to a directory in your filesystem. If you want to isolate resolution cache from repository cache, we recommend setting both the resolutionCacheDir attribute on this tag and the basedir attribute on caches instead of using defaultCache.
See cache concept for details on Ivy cache concept.

Default resolver is used whenever nothing else is configured in the modules section of the configuration file. It should give the name of a dependency resolver defined in the resolvers section of the configuration file.

Default latest strategy and conflict manager can also be configured here.

validate indicates if ivy files should generally be validate against xsd or not. This setting is only a default value, and can be overriden :
1) in ant tasks
2) in resolvers
So if there is a setting in the resolver, it always win against all other settings.

checkUpToDate indicates to ivy if it must check date of artifacts before retrieving them (i.e. copying them from
cache to another place in your filesystem). Usually it is a good thing to check date to avoid unnecessary copy, even if it's most of the time a local copy.

Attributes

AttributeDescriptionRequired
defaultCachea path to a directory to use as default basedir for both resolution and repository cache(s) No, defaults to .ivy2/cache in user home
resolutionCacheDirthe path of the directory to use to put all resolution cache data since 2.0 No, defaults to defaultCache
defaultResolverthe name of the default resolver to use No, but all modules should be configured in the modules section if not provided
defaultLatestStrategythe name of the default latest strategy to use No, defaults to latest-revision
defaultConflictManagerthe name of the default conflict manager to use No, defaults to latest-revision
defaultBranchthe default branch to use for all modules, except if they have a module specific branch setting. since 1.4 No, defaults to no default branch
circularDependencyStrategythe name of the circular dependency strategy to use since 1.4 No, defaults to warn
validateIndicates if ivy files should be validated against ivy.xsd or not. No, defaults to true
checkUpToDateIndicates if date should be checked before retrieving artifacts from cache No, defaults to true
cacheIvyPatterna pattern to indicate where ivy files should be put in cache. We recommend using the repositoryIvyPattern on the configuration/cache tag instead No, defaults to [organisation]/[module]/ivy-[revision].xml
cacheArtifactPatterna pattern to indicate where artifact files should be put in cache. We recommend using the repositoryArtifactPattern on the configuration/cache tag instead No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]
useRemoteConfigtrue to configure ivyrep and ibiblio resolver from a remote configuration file (updated with changes in those repository structure if any) (since 1.2) No, defaults to false