TeamCity Artifactory Plug-in

Configuration

To use the TeamCity Artifactory plugin you first need to configure your Artifactory servers in TeamCity's server configuration. You can then set up a project build runner to deploy artifacts and Build Info to a repository on one of the Artifactory servers configured.

Configuring System-wide Artifactory Servers

To make Artifactory servers globally available to project runner configurations, they must be defined in一个dministration | Integrations | Artifactory.

SelectCreate new Artifactory server configurationand fill in the URL of the Artifactory server.

Deployer credentials can be set at the global level for all builds, but they can also be overridden and set at a project build level.

Specifying a username and password for the resolver repository is optional. It is only used when querying Artifactory's REST API for a list of configured repositories and then only if the target instance does not allow anonymous access.

Configuring Project-specific Runners

Editing Project-specific Configuration

To set up a project runner to deploy build info and artifacts to Artifactory go to一个dministration | Projectsand select the project you want to configure.

Then, under theBuild Configurationssection, click theEditlink for the build you want to configure.

UnderBuild Configuration Settings,select the relevantBuild Stepand click theEditlink for the build step you want to configure.

When you select a value in the一个rtifactory server URLfield, the selected server is queried for a list of configured repositories (using the credentials configured in the corresponding一个rtifactory Server Configuration). This populates theTarget Repositoryfield with a list of repositories to which you can select to deploy.

Clicking on theFree-text modecheckbox enables you to type in repository name as free text. You may also include variables as part of the text.
For example: libs-%variableName%

Triggering Build Retention in Artifactory

You can trigger build retention when publishing build-info to Artifactory.

Scanning Builds with JFrog Xray

The TeamCity Artifactory Plugin is integrated with JFrog Xray through JFrog Artifactory, allowing you to have build artifacts scanned for vulnerabilities and other issues. If issues or vulnerabilities are found, you may choose to fail a build job. The scan result details are always printed into the build log. This integration requiresJFrog Artifactory v4.16and above andJFrog Xray v1.6and above.

For Xray to scan builds, you need to configure aWatchwith the right filters that specify which artifacts and vulnerabilities should trigger an alert, and set a Fail Build Job Action for that Watch. You can read more about CI/CD integration with Xrayhere.

Running License Checks

If you are using Artifactory Pro, you can benefit from theLicense Controlfeature to discover and handle third party dependency licensing issues as part of the build.
If you check theRun License Checkscheckbox, Artifactory will scan and check the licenses of all dependencies used by this build. You can also specify a list of recipients who should receive any license violation notifications by email.

Generic Build Integration

Generic build integration provides Build Info support for the following runner types:

• Command Line
• FxCop
• MSBuild
• Rake
• Powershell
• XCode Project
• NuGet Publish
• NAnt
• Visual Studio (sln)
• Visual Studio 2003
• SBT, Scala build tool

This allows the above builds to:

1. Upload any artifacts to Artifactory, together with custom properties metadata, and keep published artifacts associated with the TeamCity build.
2. Download artifacts from Artifactory that are required by your build.

You can define the artifacts to upload and download by either using "File Specs" or "Legacy Patterns".

File Specs

File Spec are specified in JSON format. You can read the File Spec schemahere.

Legacy Patterns (deprecated)

Legacy patterns are deprecated since version 1.8.0 and will be removed in future releases.

一个ttaching Searchable Parameters to Build-Info and to Published Artifacts

In theBuild Configuration Settingsyou can selectParametersto define system properties or environment variables that should be attached to artifacts and their corresponding build info.

To define a parameter click on the一个dd new parameterbutton.

FIll in the corresponding fields.

Parameters relevant for builds run through Artifactory are:

• buildInfo.property.*- All properties starting with this prefix are added to the root properties of the build-info
• artifactory.deploy.*- All properties starting with this prefix are attached to any deployed produced artifacts

You can specify all the properties in a single file, and then define another property pointing to it.

To point the plugin to a properties file, define a property calledbuildInfoConfig.propertiesFileand set its value to the absolute path of the properties file.

It is also possible to point the plugin to a properties file containing the aforementioned properties.

Black Duck Code Center Integration (deprecated)

This feature is no loner supported since version 5 of Artifactory.

If you are using Artifactory Pro and have an account withBlack DuckCode Center, you can run the build through an automated, non-invasive, open source component approval process, and monitor for security vulnerabilities.

Viewing Project-specific Configuration

Existing project configuration can be viewed inSettingsunderProjects | $PROJECT_NAME | $BUILD_NAME:

Running a Build with the Artifactory Plugin

Once you have completed setting up a project runner you can run a project build. The Artifactory plugin takes effect at the end of the build and does the following:

1. For all build runner types - Publishes the specified Published Artifacts to the selected target repository and applies corresponding path mappings.
2. For Maven or Ivy/Ant build runner - Deploys all artifacts to the selected target repository together at the end of the build (as opposed to deploying separately at the end of each module build as done by Maven and Ivy).
3. Deploys the Artifactory BuildInfo to Artifactory, providingfull traceability of the build in Artifactory, with links back to the build in TeamCity.
   
   

You can also link directly to the build information in Artifactory from a build run view:

Triggering Builds in Reaction to Changes in Artifactory

这个插件允许您设置一个新的类型的触发器that periodically polls a path in Artifactory, a folder or an individual file. Whenever a change is detected in the polled element, the TeamCity build is triggered. For example, the build could be triggered when new artifacts have been deployed to the specified path in Artifactory.

To configure a new build trigger, under一个dministration,select$PROJECT_NAME | $BUILD_NAME.Then, selectTriggers.

Click the一个dd new triggerbutton to select an一个rtifactory Build Trigger

Select the一个rtifactory Server URLand theTarget repository.

Complete the username and a password fields of a valid deployer for the selected repository.

Then, inItems to watch,specify the paths in the selected repository in which a change should automatically trigger a build.

Proxy Configuration

If the Artifactory server is accessed via a proxy, you need to configure the proxy by setting the following properties in the$TEAMCITY_USER_HOME/.BuildServer/config/internal.propertiesfile. If the file does not exist, you'll need to create it.

org.jfrog.artifactory.proxy.host org.jfrog.artifactory.proxy.port org.jfrog.artifactory.proxy.username org.jfrog.artifactory.proxy.password

Since version 2.5.0, you can also define a proxy for specific build agents. You do that by adding the TeamCity agent name to the end of the above property names.

For example, if you wish to configure a proxy for the "my-agent" agent, the proxy properties configuration should look as follows:

org.jfrog.artifactory.proxy.host.my-agent org.jfrog.artifactory.proxy.port.my-agent org.jfrog.artifactory.proxy.username.my-agent org.jfrog.artifactory.proxy.password.my-agent

Licence

The TeamCity Artifactory plugin is available under the Apache v2 License.

Release Notes