Skip to end of metadata
Go to start of metadata

White Source agent for Bamboo

A White Source external update agent for Atlassian Bamboo.


Overview

This plugin allows Bamboo users to easily create new White Source projects and updates existing ones via a Task from your build. More information can be found on the Agents project documentation.

Compatible with Bamboo Server 5.9.10 - 5.12.3.1

Please note that the plugin doesn't support the Bamboo cloud version.

Supported job types

The plugin currently supports Maven and Freestyle jobs.

Status

Actively developed and supported by White Source:

Installation

There are 3 options to install the plugin:

  1. From the Bamboo server - In the Add-ons section search the plugin "White Source agent for Bamboo" and install it. 
    Please note that if you can't find the plugin it is because your Bamboo sever is not compatible with the plugin. In this case please choose another option of downloading the plugin. 
  2. Search the Universal Plugin Manager website and install it like any other plugin, see Installing a plugin for details.
  3. Download the plugin, go to the Add-ons section and upload the plugin manually.

Download

Download the latest version.

VersionFileFeaturesRelease DateMD5
2.0.1whitesource-bamboo-agent-2.0.1.jarWhether or not update organization inventory regardless of policy violations.2017-04-25DAD8B05FF0958509584C515E89AE03ED
2.0.0whitesource-bamboo-agent-2.0.0.jar

Compatibility with new version of Bamboo servre

2016-07-20 0347E093965F56972006B7575C666EF5

Configuration

Within your job add the WhiteSource task, the task will automatically recognize if this is a Maven or a freestyle task by checking if there is a Maven task present before the WhiteSource task.

Please note that the WhiteSource task is not a standalone task and relies on the source code checkout and/or maven task.

Parameters

Maven jobs

  • API key - Uniquely identifies your White Source account organization.
  • Policy violation, fail build?Will fail the job in case there is a policy violation with any of the scanned components.
  • Force Update - Whether or not update organization inventory regardless of policy violations.
  • Wss url - Destination url for the WhiteSource request  
  • Product token or name - Maps the result of the current job to a specific WhiteSource product which may be identified either by name or by the token. The default value will be the Bamboo top most project name or artifactId in the case of a maven task.
  • Product version - Use this to override the version in each module.
  • Project token - Uniquely identifies the project built by the job.
  • Module tokens - Map of module artifactId to White Source project token.
  • Module Includes - Only modules with an artifactId matching one of these patterns will be processed by the plugin.
  • Module Excludes - Modules with an artifactId matching any of these patterns will not be processed by the plugin.
  • Ignore POM modules? - Checking this option will ignore maven modules of type POM.

Freestyle jobs

  • API keyUniquely identifies your White Source account organization.
  • Policy violation, fail build - Checking this option will check policies before any update.
  • Force Update - Whether or not update organization inventory regardless of policy violations.
  • Wss url - Destination url for the WhiteSource request  
  • Product token or name - Maps the result of the current build to a specific WhiteSource product which may be identified either by name or by the token. The default value will be the Bamboo top most project name or artifactId in the case of a maven task.
  • Product version - Use this to override the version in each module.
  • Project token - Uniquely identifies the project built by the job.
  • File Includes - Ant-style FileSet pattern to determine which files to include as dependencies. Relative to the job's workspace.
  • File Excludes - Ant-style FileSet pattern to determine which files to exclude as dependencies. Relative to the job's workspace.

HTTP(S) Proxy

If your Bamboo instance is running behind a firewall, the plugin will reuse the proxy configuration from Bamboo, see Cannot connect to an AWS or EC2 instance when the Bamboo application is running behind a proxy for details.

Executing the plugin

Simply run the plan which contains the White Source task.

Sample log output:

License

Licensed under the Apache License, Version 2.0, see LICENSE for details.

Labels
  • None