Page Comparison

...

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.

Supported since version 1.7. For previous versions of Jenkins plugin click here. 

...

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.

...

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

...

Installing The Plugin

1. Go to Manage

...

1. Jenkins > Manage

...

1. Plugins > Available.

2. Search for

...

1. WhiteSource, select the checkbox, and click 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.

...

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

Go to the WhiteSource section.

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

...

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.

* Environment variable support from version 1.8.1

...

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 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 that is the sole purpose of the configuration.Image Removed

...

*Environment variable support from version 1.8.1

...

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

...

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:

...

After filling the desired fields, press the "click 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 

Pipeline step sample

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