Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Note

IMPORTANT: The TeamCity plugin will reach its End Of Life starting November 1, 2021.

After this date, WhiteSource will no longer provide standard support, including updates and fixes, for the deprecated plugin. Extended Support, which is limited to configuration and Support troubleshooting, will continue until May 1, 2022. Following this date, the TeamCity plugin will no longer be supported by WhiteSource. Please make sure to migrate to the Unified Agent before the end of standard support on November 1, 2021 to maintain full support of your product.

Overview

The plugin integrates automatic open source management with Jetbrains TeamCity

...

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

  1. Go to Administration →  Server >  Server Administration > Plugins List.

  2. Click on the “Upload plugin zip” button Upload plugin zip, and navigate to the location of the plugin's zip file.

    Image RemovedImage Added

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

...

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

...

  • Organization Token: A unique identifier of the organization. You can retrieve it in the Admin Integration API page.

  • User Key: Unique user key. See User Level Access Control in Integrations and APIs for more information. 

  • Policy Check: Checks that the introduced open source libraries conform with organization policies.

    • Check only new libraries: Check that the newly introduced open source libraries conform with organization policies.

    • Force check all libraries: Check that all introduced open source libraries conform with organization policies. 

    • Disable: Disable policies check when updating WhiteSource.

  • Force Update: Updates organization inventory regardless of policy violations.

  • Fail on Error: Indicates whether or not to fail the build on a general error (e.g. network error).

  • Service URL: URL of the environment on which the WhiteSource organization is hosted. The default ishttps://saas.whitesourcesoftware.com”; therefore organizations hosted on that can leave this field blank.

  • Connection Timeout (optional): Connection timeout value in minutes. If the field is left blank then , the value is 60 minutes.

  • Proxy Server (optional)If TeamCity is behind a firewall then you should select the checkbox. As displayed in the following screenshot, once the checkbox is selected, newly displayed fields can be filled in, in order to allow communication with the WhiteSource servers. 

    Image Removed


    Image Added

Environment Variable - Skip plugin

...

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

...


...

Job Specific Settings

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

Info

Only supported runner types will have this these options visible.

Maven Runner

...

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

...

...

Install the plugin and import data into WhiteSource.

Widget Connector
overlayyoutube
_templatecom/atlassian/confluence/extra/widgetconnector/templates/youtube.vm
width400px
urlhttp://www.youtube.com/watch?v=aeOQw0ou694&feature=plcp
height300px

Apply policy check before updating WhiteSource.

Widget Connector
overlayyoutube
_templatecom/atlassian/confluence/extra/widgetconnector/templates/youtube.vm
width400px
urlhttp://www.youtube.com/watch?v=48f2_5mFh-s&feature=plcp
height300px

Change Log

...

Version

...

Change Log

Version

Description

Version 21.6.2

  • Dependency upgrde

Version 21.4.1

  • Upgrade com.thoughtworks.xstream and com.fasterxml.jackson.core dependencies version

Version 21.1.1

  • Upgrade com.thoughtworks.xstream dependency  version to 1.4.15

Version 20.11.2

  • Upgrade com.thoughtworks.xstream dependency  version to 1.4.14 

Version 20.10.2

  • Upgrade junit dependency  version to 4.13.1 

Version 20.7.1

  • Upgraded the XStream Core dependency to version 1.4.12

Version 20.6.2

  • Bug fix - check policies

Version 19.11.2

Version 19.9.2.2

  • Minor Fixes

Version 19.5.3

  • Minor Fixes

Version 19.1.2

  • Update agent api version

Version 18.10.1

Version 18.6.2

  • Resume build upon failed communication to server.

Version 18.5.1

  • Added support for user-level access control in integrations.

Version 17.11.4

  • Improve hash processing.

  • Add parameter to enable/disable whitesource plugin (SKIP_WHITESOURCE_PLUGIN = true ).

  • Bug Fix - Fail or error : Build did not pass despite the flag set to false.

Version 1.1.7

  • Add 'fail on error' functionality - fails the build even in case of inventory force update, or other general errors.

Version 1.1.6

  • Add force update functionality.

Version 1.1.5

  • Add support for force check all dependencies (old and new) according to the organization policies

  • Bug Fix - use global settings in maven runner.

Version 1.1.4

  • Add connection timeout parameter. Connection timeout is measured in minutes. Default value is 60 minutes.

Version 1.1.3

  • Automatic proxy detection + minor bug fixes.

Version 1.1.2

  • Product identification in agent api

  • Improved proxy configuration

  • Option to change service url

Version 1.1.1

Minor changes:

  • Communication with WhiteSource servers is now encrypted using SSL by default.

  • Several bug fixes in policy check report

  • Code refactor

Version 1.1.0

First release of the plugin.

...