Artifact Dependencies

Artifacts Rules

Here you specify the artifacts of the source build to be downloaded and the location on the agent they will be downloaded to before the dependent build starts.

A newline-delimited set of rules. Each rule must have the following syntax:

Each rule specifies the files to be downloaded from the "source" build. The SourcePath should be relative to the artifacts' directory of the "source" build. The path can either identify a specific file, directory, or use wildcards to match multiple files. Ant-like wildcards are supported.
Downloaded artifacts will keep the "source" directory structure starting with the first * or ?.
DestinationPath specifies the destination directory on the agent where downloaded artifacts are to be placed. If the path is relative (which is recommended), it will be resolved against the build checkout directory. If needed, the destination directories can be cleaned before downloading artifacts. If the destination path is empty, artifacts will be downloaded directly to the checkout root.

Basic examples:

• Use a/b/**=>lib to download all files from a/b directory of the source build to the lib directory. If there is a a/b/c/file.txt file in the source build artifacts, it will be downloaded into the file lib/c/file.txt.

• At the same time, artifact dependency **/*.txt=>lib will preserve the directories structure: the a/b/c/file.txt file from source build artifacts will be downloaded to lib/a/b/c/file.txt.

ArchivePath is used to extract downloaded compressed artifacts. zip, 7zip, jar, tar, and tar.gz are supported.
ArchivePath follows general rules for SourcePath: ant-like wildcards are allowed, the files matched inside the archive will be placed in the directory corresponding to the first wildcard match (relative to destination path)
For example: release.zip!*.dll command will extract all .dll files residing in the root of the release.zip artifact.

Archive processing examples:

• release-*.zip!*.dll=>dlls will extract *.dll from all archives matching the release-*.zip pattern to the dlls directory.

• a.zip!**=>destination will unpack the entire archive saving the path information.

• a.zip!a/b/c/**/*.dll=>dlls will extract all .dll files from a/b/c and its subdirectories into the dlls directory, without the a/b/c prefix.

+: and -: can be used to include or exclude specific files from the download or unpacking. As +: prefix can be omitted: rules are inclusive by default, and at least one inclusive rule is required. The order of rules is unimportant. For each artifact the most specific rule (the one with the longest prefix before the first wildcard symbol) is applied. When excluding a file, DestinationPath is ignored: the file won't be downloaded at all. Files can also be excluded from archive unpacking. The set of rules applied to the archive content is determined by the set of rules matched by the archive itself.

Exclusive patterns examples:

• **/*.txt=>texts
-:bad/exclude.txt Will download all *.txt files from all directories, excluding exclude.txt from the bad directory

• +:release-*.zip!**/*.dll=>dlls -:release-0.0.1.zip!Bad.dll Will download and unpack all *.dll files from release-*.zip files to the *.dlls' directory. The Bad.dll file from release-0.0.1.zip will be skipped

• **/*.*=>target
-:excl/**/*.*
+:excl/must_have.txt=>target Will download all artifacts to the target directory. Will not download anything from the excl directory, but the file called must_have.txt

The artifacts placed under the .teamcity directory are considered hidden. These artifacts are ignored by wildcards by default.
If you want to include files from the .teamcity directory for any purpose, be sure to add the artifact path starting with .teamcity explicitly.

Example of accessing hidden artifacts:

• .teamcity/properties/*.properties

• .teamcity/*.*

By default, downloading artifact dependencies to the agent work directory is allowed, the agent home directory is prohibited. To override the defaults, set custom rules to download artifacts by specifying the comma-separated paths in the buildAgent.properties: teamcity.artifactDependenciesResolution.bannedList and teamcity.artifactDependenciesResolution.allowedList. Adding a path to the banned list forbids artifacts download to this directory unless it is present in the allowed list.

Automatic allocation of space for artifact dependencies

TeamCity automatically frees disk space for resolving artifact dependencies based on the artifacts' size. You don't need to configure it manually.