Bamboo JFrog Plugin
Add a JFrog CLI task to Bamboo plans and run commands against Artifactory.
The Bamboo JFrog Plugin adds a JFrog CLI Task to Bamboo build plans and deployment projects. The task selects a configured JFrog Platform connection, installs JFrog CLI, and runs the command you enter after jf.
Warning
For new automation, run JFrog CLI from a standard Bamboo Script or Command task. The JFrog plugin remains useful for existing compatible installations, but Bamboo Data Center is approaching end of life and JFrog plugin certification for Bamboo Data Center 12.x is not established. Plan migration away from Bamboo Data Center and confirm your exact Bamboo and plugin combination with JFrog Support before upgrading.
This page covers the following tasks:
Prerequisites
- A compatible Bamboo Data Center installation.
- Bamboo administrator permission to install an app and configure a JFrog Platform connection.
- A JFrog Platform URL and credentials.
- An agent that can run the selected JFrog CLI command.
- Network access to JFrog releases, or an Artifactory remote or virtual repository that proxies JFrog CLI downloads.
- The plugin currently compiles against Bamboo 10.2.0 and Java 17. Confirm the supported Bamboo and plugin combination with JFrog Support before upgrading.
- A local repository of the matching package type, deploy plus publish-build-info permission, and the same build name and number on CLI commands and
jf rt build-publish.
Before You Begin
For new work, prefer JFrog CLI in a Script task. For more information, see How Build Integration Works and Choose Plugin, CLI, or CI Wrapper.
Install and Configure the Plugin
The plugin installation adds the JFrog CLI task type to Bamboo, and the JFrog Platform configuration supplies the server ID that JFrog CLI tasks select.
To install and configure the plugin:
- Install JFrog for Bamboo from Atlassian Marketplace.
- In Bamboo administration, open Manage apps > JFrog Configuration.
- Select New JFrog Platform Configuration.
- Enter a unique server ID, JFrog Platform URL, and credentials.
- Test the connection and save.
- Keep the default JFrog CLI version, choose a specific version, or configure a remote or virtual Artifactory repository that proxies
https://releases.jfrog.io/.
Run Your First JFrog CLI Task
The JFrog CLI Task runs the jf command you enter against the server ID you select.
To run a JFrog CLI task in a build plan:
- Open the tasks for a Bamboo build job.
- Add JFrog CLI Task.
- Select the configured server ID.
- In the command field, enter:
jf rt ping- Run the plan.
The task form expects a command beginning with jf. The plugin removes the leading jf, switches JFrog CLI to the selected server with jf config use, and runs the remaining arguments.
Expected result: the task succeeds and the build log reports a successful Artifactory ping.
Publish Build Information
For more information about the data a build publish collects, see About Build Info. Build-plan tasks set the following variables.
| Variable | Bamboo value |
|---|---|
JFROG_CLI_BUILD_NAME | Plan name |
JFROG_CLI_BUILD_NUMBER | Bamboo build number |
JFROG_CLI_BUILD_URL | Bamboo result URL |
Add package or upload tasks before a final JFrog CLI Task containing:
jf rt build-publishThe command publishes data collected for the current plan name and build number.
Note
Deployment-project tasks do not have build-plan metadata. Pass a build name and number explicitly when a deployment task must address an existing build.
View the Build in Artifactory
Open Builds in Artifactory and find the Bamboo plan name and build number. UI labels remain subject to product-version differences. For more information about working with published builds, see Inspect Builds.
Run Other JFrog CLI Commands
The task is a general JFrog CLI wrapper. Examples:
jf rt u "dist/*" my-generic-local/
jf rt build-publish
jf build-scanUse package-manager configuration commands before package builds, for example jf mvn-config before jf mvn. Validate command flags against the CLI version selected in the plugin.
JFrog CLI Installation
By default, the plugin installs the latest JFrog CLI version when the task runs. You can pin a version. If agents cannot reach JFrog releases directly, configure a remote or virtual repository in Artifactory that proxies the releases endpoint and select it in the JFrog configuration.
Existing Bamboo Artifactory Plugin Users
The Bamboo Artifactory Plugin (Legacy) and Bamboo JFrog Plugin can coexist. The Artifactory plugin provides package-specific historical tasks. The JFrog plugin exposes current JFrog CLI commands. Because the recommended path for new Bamboo work is now a standard Script or Command task, migrate by translating each historical task to an explicit jf sequence and testing it in a staging plan.
Troubleshooting
The following table lists common failures and how to respond to them.
| What you see | Cause | What to do |
|---|---|---|
| Selected server does not exist | The task references a removed configuration. | Edit the task and choose an existing server ID. |
| CLI download fails | The agent cannot reach JFrog releases. | Configure an Artifactory proxy repository or make a compatible CLI available to the agent. |
jf command fails with 401 or 403 | Credentials or permissions are insufficient. | Test the connection and verify repository and build permissions. |
| Build is missing from Artifactory | Build publish did not run, or deployment context lacked build metadata. | Run jf rt build-publish. In deployment projects, pass the build name and number explicitly. |
| Plugin cannot be installed or loaded after a Bamboo upgrade | The Bamboo and plugin combination may be incompatible. | Roll back in staging and confirm lifecycle support with JFrog Support. |
Related Topics
Updated about 1 month ago