Page Comparison

Image Removed

General Information

The plugin integrates automatic open source management with Jenkins. 

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

• New projects will be created
• Existing projects will be updated
• Policies will be enforced on every action, failing the build if necessary.

...

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

Before you begin, note the following:

• The native Jenkins plugin does not support NPM resolution through package.json

• The Jenkins plugin documentation contains documentation for General or Maven jobs only.

• The Jenkins plugin is useful for Maven projects or for source file scanning.

How it Works

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

Normal Flow

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

Policy Check Flow

The plugin checks each new library against the organizational policies. If a library is automatically rejected by a policy then the build fails. Otherwise, your account is updated.

An informative report of the results is generated, regardless of the outcome.

The report files are saved in:

$JENKINS_HOME\jobs\<job name>\\builds\<build YYYY-MM-DD_HH-mm-ss>\whitesource

Image Removed

Installing The Plugin

Go to Manage Jenkins → Manage Plugins → Available.

Search for WhiteSource → Select the checkbox → Press Install

Using The Plugin

Start by configuring the global settings. These settings will apply across all jobs on this Jenkins master. Then setup the jobs which should interact with WhiteSource.

Global WhiteSource Configuration

Once the plugin is installed, go to Manage Jenkins →  Configure System.

Go to WhiteSource section.

Image Removed

• Selecting the 'Fail on error' checkbox instructs to fail the build on a general error (e.g., network error) or a policy violation.
  Clearing this checkbox indicates that the plugin fails the build only for policy violations.
• Connection timeout is measured in minutes. Default value is 60 minutes.

API Token

A unique identifier of the organization. You can receive an API token in the administration section of your WhiteSource account.

Service url

URL to where the request is sent. 

Use the 'WhiteSource Server URL' which can be retrieved from your 'Profile' page on the 'Server URLs' panel. For example: "https://saas.whitesourcesoftware.com".

Check policy compliance

Check 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.

Job Specific Settings

For each job you want to use the plugin for, you need to add a post build action. In job configuration 

Image Removed

Common Configuration

These fields are common to all job types. They are mainly here to allow different values for global settings.

Image Removed

...

Environment variable support

...

Name or token to uniquely identify the product to update.

...

* Environment variable support from version 1.8.1

Maven Jobs

Normally, for maven 2/3 jobs, no extra configuration is required.

However, if you do need more control on the plugin behavior, click on Advanced to show more options.

Image Removed

...

Freestyle Jobs

Projects with no concise system for managing dependencies, like maven, require 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.

Image Removed

...

*Environment variable support from version 1.8.1

Supported Extension Types

Currently we support the following file extensions:

Binary File Extensions

jar, aar, dll, tar.gz, egg, whl, rpm, tar.bz2, tgz, deb, gzip, gem, swf, swc

Source File Extensions

c, cc, cp, cpp, cxx, c++, go, goc, h, hpp, hxx, m, mm, c#, cs, csharp, java, js, php, py, rb, swift

Pipeline Support

In order to use the WhiteSource Jenkins plugin, the following is required:

• Jenkins version 2.x or later.
• Pipeline plugin installed.
• WhiteSource plugin version 1.8.x or later.

The Pipeline support also consists of Global WhiteSource Configuration:

Image Removed

And the job configuration, which is available when selecting the WhiteSource plugin inside the snippet generator:

Add the Generated Script

After filling the desired fields, press the "Generate Groovy" button, and a groovy script will be generated, according to the specific job configuration.

Add the generated script to any build step inside your Jenkins Pipeline script file:

Image RemovedImage Removed

Maven pipeline 

node {
   stage ('Build') {
   withMaven(
       maven: 'maven',
       mavenSettingsFilePath: 'path-to/settings.xml',
       mavenLocalRepo:'~/.m2/repository') {
     whitesource jobApiToken: 'api-token', jobUserKey:'user-key', libIncludes: '**/*.jar **/*.js', libExcludes: '', product: 'FT', productVersion: '', projectToken: '', requesterEmail: ''
   } 
 }
}

Link to known versions of whitesource jenkins plugin 

https://updates.jenkins.io/download/plugins/whitesource/

Change Log

...

...

...

...

...

• Update agents version

...

• Minor bug fixes

...

• Minor bug fix - fix text message
• Support both service URL with and without "/agent"  

...

• Minor bug fixes

...

• Minor bug fixes

...

• Resume Build upon failed communication to server.

...

• Bug fix - using project token as identifier.

...

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

...

Add support  for maven pipeline job.

...

10 Dec 2017 

...

Minor fixes.

...

Bug fix - NPE exception on enviroment variables.

...

Add support for enviroment variables.

...

Minor fixes - remove jelly importing.

...

Add support for generic pipeline job.

...

Enable build failure on policy violation (even when force update is enabled).

...

...

• Product identification.
• Well known file extensions are now scanned by default in free style jobs.
• Bug fixes.

...

Minor changes:

• Communication with White Source servers is now encrypted using SSL by default.
• Several bug fixes in policy check report

...

This page is available at: https://docs.mend.io/bundle/unified_agent/page/jenkins_plugin.html