Overview

The plugin integrates automatic open source management with Jetbrains TeamCity

Once set up, all usage of open-source software in the organization will be continuously and automatically in sync with WhiteSource.

The plugin currently support build steps with either Maven, Ant, or shell script Runner types.

The plugin is licensed under the Apache 2.0 license. Source code and issues are hosted on github .

How it Works

On execution, the plugin will determine which open source is currently used by your project and send it to WhiteSource.

No source code is scanned. Only descriptive information is sent over the wire.

Normal Flow

WhiteSource uses the collected information to create new projects or update existing ones.

Policy Check Flow

The plugin will check each new library against the organizational policies. If any library is automatically rejected by some policy, the build will fail. Otherwise your account will be updated.

An informative report of the results will be generated regardless of the outcome.

Installing the Plugin

Download the plugin:

TeamCity VersionWhiteSource plugin
7.0+teamcity-whitesource-plugin-21.1.1.zip
7.0+teamcity-whitesource-plugin-20.11.2.zip
7.0+teamcity-whitesource-plugin-20.10.2.zip
7.0+teamcity-whitesource-plugin-20.7.1.zip
7.0+teamcity-whitesource-plugin-20.6.2.zip
7.0+teamcity-whitesource-plugin-19.11.2.zip
7.0+teamcity-whitesource-plugin-19.9.2.2.zip
7.0+teamcity-whitesource-plugin-19.5.3.zip
7.0+teamcity-whitesource-plugin-19.1.2.zip
7.0+teamcity-whitesource-plugin-18.10.1.zip
7.0+teamcity-whitesource-plugin-18.6.2.zip
7.0+teamcity-whitesource-plugin-17.11.4.zip
7.0+teamcity-whitesource-plugin-1.1.7.zip
7.0+teamcity-whitesource-plugin-1.1.6.zip
7.0+teamcity-whitesource-plugin-1.1.5.zip
7.0+teamcity-whitesource-plugin-1.1.4.zip
7.0+teamcity-whitesource-plugin-1.1.3.zip
6.5.5+teamcity-whitesource-plugin-1.0.3.zip

Installation of the plugin is done directly via the TeamCity GUI:

  1. Go to Administration →  Server Administration → Plugins List.
  2. Click on the “Upload plugin zip” button, and navigate to the location of the plugin's zip file.



  3. Restart the TeamCity server (this task can also be done via the TeamCity GUI).

Using the Plugin

Start by configuring the global settings, these settings will be applied to every project in your TeamCity environment. Then, setup the jobs that should interact with WhiteSource.

Global Settings

Once the plugin is installed go to Administration →  Integrations → WhiteSource.

Environment Variable - Skip plugin

By setting SKIP_WHITESOURCE_PLUGIN to true the plugin will be disabled.

Connection Retries

Number of connection retries when unable to connect to WhiteSource service (default value is 1).

Connection Retries Interval

Connection interval in seconds between two connection retries to WhiteSource service (default value is 3 seconds).


Job Specific Settings

You should enable the plugin for each job you want to use to update WhiteSource.

Only supported runner types will have this options visible.

Maven Runner


Generic Configuration

Build runners that have no concise system for managing dependencies require a different configuration.

What we're looking for is descriptive information about each library used. What we need to know is which libraries to include and where we can find them, that is the sole purpose of the configuration.



Build Log

The plugin is executed when the runner finish. Sample log section:

Screen Casts

Install the plugin and import data into WhiteSource.


Apply policy check before updating WhiteSource.

Change Log









Version 21.1.1

Version 20.11.2

Version 20.10.2

Version 20.7.1

Version 20.6.2

Version 19.11.2

Version 19.9.2.2

Version 19.5.3

Version 19.1.2

Version 18.10.1

Version 18.6.2

Version 18.5.1

Version 17.11.4

Version 1.1.7

Version 1.1.6

Version 1.1.5

Version 1.1.4

Version 1.1.3

Version 1.1.2

Version 1.1.1

Minor changes:

Version 1.1.0

First release of the plugin.