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.
Supported since version 1.7. For previous versions of Jenkins plugin click here.
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.
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
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 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.
A unique identifier of the organization. You can receive an API token in the administration section of your WhiteSource account.
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
These fields are common to all job types. They are mainly here to allow different values for global settings.
Environment variable support
|Product name or Token|
Name or token to uniquely identify the product to update.
|Product version||Version of the product to update.||Yes|
|Check only new libraries||Optionally override this property from global configuration.||Yes|
|Force check all libraries||Optionally override this property from global configuration.||No|
|Force update||Updates organization inventory regardless of policy violations. ||No|
|Override API token||Optionally override this property from Global WhiteSource Configuration.||Yes|
|Override userKey||Unique identifier of user, can be generate from the profile page in your whitesource account.||Yes|
|Project token||Unique identifier of the White Source project to update. If omitted, default naming convention will apply.||Yes|
|Requester email||Email of the WhiteSource user that requests to update WhiteSource.||Yes|
|Connection Retries||Connection retries when unable to connect to WhiteSource service.||Yes|
|Connection Retries Interval||Wait time between connection retries.||Yes|
* Environment variable support from version 1.8.1
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.
|Module tokens||Map of module artifactId to WhiteSource project token.|
|Modules to include||Only modules with an artifactId matching one of these patterns will be processed by the plugin.|
|Modules to exclude||Modules with an artifactId matching any of these patterns will not be processed by the plugin.|
|Ignore pom modules||Set to true to ignore this maven modules of type pom.|
|Connection Retries||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).|
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.
|Parameter||Meaning||Environment variable support|
|Includes||Comma, space or line separated list of Ant style GLOB patterns specifying which files to include in scan.||Yes|
|Excludes||Comma, space or line separated list of Ant style GLOB patterns specifying which files to exclude form scan.||Yes|
*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
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:
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:
Link to known versions of whitesource jenkins plugin