Bamboo Artifactory Plug-in

Configuration

To use the Bamboo Artifactory plug-in you need to set up your Artifactory server(s) in Bamboo's server configuration. You can then set up a project builder to deploy artifacts and build-info to a repository on one of the configured Artifactory servers.

Configuring Maven 3, Gradle and Ivy Builders

Before you begin with any Artifactory-specific setup, ensure that Maven 3, Gradle and/or Ivy builders are available for project configurations.

These builders are defined asServer Capabilities in Bamboo

To define Server Capabilities for builders:

1. Under theAdministrationmenu, selectOverviewto view theBamboo administrationpage.
2. Then, underBuild ResourcesselectServer Capabilities
   
3. SelectExecutableas theCapability Type
4. SelectArtifactory Maven 3,Artifactory GradleorArtifactory Ivy作为类型from theTypeslist.
5. Make sure thatPathpoints to an installation directory of the selected builder type.

Configuring System-wide Artifactory Server(s)

To make Artifactory servers available to project configurations, they must be defined underAdministration | Plugins | Artifactory Plugin.

Enter the Artifactory server URL in theAdd New Server Configurationfields.

Configuring a Project Builder

To set up a project task to deploy build-info and artifacts to Artifactory:

1. Go to theTasksstep of your jobs configuration.
2. When adding a task type, select the Artifactory Maven 3, Gradle or Ivy builder
   
3. The builder configuration fields appear and include Artifactory and build-info configuration options.

Selecting Artifactory Servers and Repositories

Select an Artifactory server URL for resolving artifacts and to deploy build artifacts in the corresponding fields.

If you have configured theSystem Wide Artifactory Serverscorrectly with the required credentials, then once you select an Artifactory server, the corresponding fields are populated to let you choose aResolution RepositoryandTarget Repository.

TheTarget Repositoryfield is populated with a list of available target repositories as returned by the server (queried with the credentials in the server configuration, if provided).

If the repository list remains empty, ensure the specified Artifactory server URL and credentials (if provided) are valid.

Select the target repository you want Bamboo to deploy artifacts and build-info to.

Running Licence Checks

If you have an Artifactory Pro license, you can set theRun License Checkscheckbox so that Artifactory will scan all dependencies used by the build to check for any license violations.

This feature offers the following options:

Black Duck Code Center Integration

If you have an Artifactory Pro license, and a Black Duck Code Center account you can use theArtifactory Black Duck Code Center integrationto automatically initiate an open source component approval process, and proactively monitor for security vulnerabilities.

This feature offers the following options:

The Artifactory Generic Resolve Task

The Generic Resolve task can be used in any job with any combination of tasks.

It lets you specify dependency patterns that should be downloaded from Artifactory through the creation of File Specs. Read more about File Specshere.

Before version 2.2.0, specifying dependency patterns was possible through Legacy Patterns, which became deprecated in version 2.2.0

The Artifactory Generic Deploy Task

The Generic Deploy task can be used in any job with any combination of tasks, and is provided to offer minimal Build Info support for all types.

This task collects all available information regarding the build from Bamboo, and provides a deployment mechanism for the artifacts produced.

Adding the Generic Deploy task automatically deploys Build Info collected from the Published Artifacts declaration in addition to the artifacts themselves. Specifying artifact patterns to be deployed to Artifactory is done through the creation of File Specs. Read more about File Specshere.

Before version 2.2.0, specifying artifact patterns was possible through Legacy Patterns, which became deprecated in version 2.2.0

Using File Specs

File Spec are specified in JSON format. They are used in theGeneric ResolveandGeneric Deploytasks, to specify the dependencies to be resolved from Artifactory or artifacts to be deployed to it.
You can use File Specs in one of the following ways:

1. Manage them in your SCM, and then during the build, have them pulled to the workspace with the other sources. If you choose this option, you should select the "File" option in the "Upload spec source" or "Download spec source" field and specify the relative path to the File Spec in your workspace.
2. Save the File Spec JSON as part of the job configuration. If you choose this option, you should select the "Job configuration" option in the "Upload spec source" or "Download spec source" field and specify the File Spec JSON content in your workspace in the "File path" field.

You can read the File Spec schemahere.

Deployment Projects

The Bamboo Artifactory Plugin also supports Bamboo Deployment projects (read more about Deployment projectshere).

• TheArtifactory Downloadtask downloads artifacts from Artifactory. The artifacts to be downloaded are defined usingFile Specs.
• TheArtifactory Deploymenttask collects the build artifacts which are shared by the build plan associated with the deployment task, and uploads them to Artifactory. In addition, artifacts which were downloaded by Artifactory Download task are also available for deployment.

Running a Build

Once you have completed setting up a project builder you can run it. The Artifactory plug-in commences at the end of the build and:

1. Deploys all artifacts to the selected target repository in one go (as opposed to the deploy at the end of each module build, used by Maven/Ivy).
2. Deploys the Artifactory build-info to the selected server, which providesfull traceability of the build in Artifactory, with links back to the build in Bamboo.

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

License

The Bamboo Artifactory plug-in is available under the Apache v2 License.

Attaching Searchable Parameters

You can define parameters that should be attached to build info and artifacts that are deployed by the plugin.

To define a parameter, underAdministrationgo toBuild Resources | Global Variables,fill in aKey/Valuepair and clickSave.

The available parameter types are:

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

Using a Properties File

Instead of defining properties manually, you can point the plug-in to a properties file.

To do so, define a property namedbuildInfoConfig.propertiesFileand set its value to the absolute path of the properties file.

Overriding Plan values using Bamboo Variables

The Artifactory Plugin supports overriding various in the plan configuration like Deployer credentials, Resolver credentials, repositories etc.

If you wish to override any of the values specified in the table below, you need to configure them as Bamboo variables either through the UI or append then to the REST URL request as a query parameters.

When assigning any value to these Bamboo variables, it will override the job configuration.

curl -ubamboo-user:bamboo-password -XPOST "http://:8085/rest/api/latest/queue/MVN-JOB?stage&executeAllStages&bamboo.variable.artifactory.override.deployer.username=new_username&bamboo.variable.artifactory.override.deployer.password=new_password"

In the example above, we use CURL to remotely invoke a Bamboo plan. We set the Deployer username and Deployer password for this specific request.

Note that we add the"bamboo.varaible"prefix to the query parameters.

Release Management

The Artifactory Plugin provides a powerful feature for release management and promotion. For details please refer toBamboo Artifactory Plugin - Release Management.

Push to Bintray (Deprecated)

Bintray users can publish build artifacts to Bintray by using the Artifactory Bintray integration.
This can be done on thePush to Bintraytab of the Bamboo Artifactory Plugin in one of two ways:

1. You can configure your Bintray details in adescriptor filewhich should be added to your list of build artifacts
2. You can check theOverride descriptor filecheckbox and specify the details in thePush to Bintray tab UI.

Using a Descriptor File

1. Create a descriptor file namedbintray-info.json.

{ - "repo": { + "name": "test", - "type": "generic", - "private": false, - "premium": false, - "desc": "My test repo", - "labels": ["label1", "label2"], - "updateExisting": false }, + "package": { + "name": "auto-upload", + "repo": "test", + "subject": "myBintrayUser", - "desc": "I was pushed completely automatically", - "website_url": "www.www.si-fil.com", - "issue_tracker_url": "https://github.com/bintray/bintray-client-java/issues", + "vcs_url": "https://github.com/bintray/bintray-client-java.git", + "licenses": ["MIT"], - "labels": ["cool", "awesome", "gorilla"], - "public_download_numbers": false, - "public_stats": false, - "attributes": [{"name": "att1", "values" : ["val1"], "type": "string"}, {"name": "att2", "values" : [1, 2.2, 4], "type": "number"}, {"name": "att5", "values" : ["2014-12-28T19:43:37+0100"], "type": "date"}] }, + "version": { + "name": "0.5", - "desc": "This is a version", - "released": "2015-01-04", - "vcs_tag": "0.5", - "attributes": [{"name": "VerAtt1", "values" : ["VerVal1"], "type": "string"}, {"name": "VerAtt2", "values" : [1, 3.3, 5], "type": "number"}, {"name": "VerAtt3", "values" : ["2015-01-01T19:43:37+0100"], "type": "date"}], - "gpgSign": false }, "applyToFiles": ["repo1/org/jfrog/*.*", "repo2/org/jfrog/test/module*/*.jar", "repo3/org/jfrog/test/**/*.*", "repo2/org/jfrog/test/**/art.?ar"], "applyToRepoFiles": ["/org/jfrog/*.*, jfrog/test/**/*.*"], "applyToProps": [{"upload.prop1": ["val1", "val2"]}, {"upload.prop2": ["*"]}, {"*": ["valueRegardlessOfProperty"]}], "publish": true }

2. Commit the descriptor file to your source control along with your project sources.
3.Modify your build script to attach the file to your build artifacts.

Using the "Push to Bintray" Tab UI

1. Check theOverride descriptor filecheckbox in thePush to Bintraytab.
2. Fill in the fields that are displayed.

Maven Central sync with Bintray

When checking the "Maven Central Sync" checkbox in Push to Bintray configuration page your build will be published to Maven Central after it is pushed to Bintray.

configuration

In order to use Maven Central sync you need to configure your Bintray and Sonatype OSS credentials in Artifactory plugin page like shown in the image below.

Release Notes