...
| Table of Contents |
|---|
| Note |
|---|
IMPORTANT: The Jenkins plugin will reach its End Of Life starting August 1, 2022. 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 February 1, 2023. Following this date, the Jenkins plugin will no longer be supported by WhiteSource. Please make sure to migrate to the Unified Agent before the end of standard support on August 1, 2022 to maintain full support of your product. |
General Information
The plugin integrates automatic open source management with Jenkins.
...
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".
...
These fields are common to all job types. They are mainly here to allow different values for global settings.
Parameter | Description | Environment variable support |
|---|---|---|
Product name or Token | Name or token to uniquely identify the product to update. | Yes |
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 RetriesInterval | Wait time between connection retries. | Yes |
* 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.
...
Parameter | Description |
|---|---|
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). |
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.
...
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
...
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:
...
Link to known versions of WhiteSource Jenkins plugin
https://updates.jenkins.io/download/plugins/whitesource/
Change Log
Version | Features | Release Date |
|---|---|---|
20.8.1 |
| |
19.1.1 |
|
|
18.10.2 |
| |
18.10.1 |
| |
18.8.2 |
| |
18.6.3 |
| |
18.6.2 |
| |
18.5.2 |
| |
18.5.1 |
|
|
18.1.3 | Add support for Jenkins 2.102 |
|
18.1.1 | Bug fix - Freestyle job runinng |
|
17.12.1 | Add support for maven pipeline job |
|
17.11.4 | Minor fixes |
|
1.8.2 | Bug fix - NPE exception on enviroment variables |
|
1.8.1 | Add support for enviroment variables |
|
1.8.0 | Minor fixes - remove jelly importing |
|
1.7.9 | Add support for generic pipeline job |
|
1.7.8 | Enable build failure on policy violation (even when force update is enabled) |
|
1.7.7 | Bug fix - ignore for pom modules field |
|
1.7.6 | Add force update option |
|
1.7.5 | Bug fix - save proxy port |
|
1.7.4 | Bug fix - fixing possible NPEs |
|
1.7.3 | Minor fixes |
|
1.7.2 | Move to JDK 1.7 |
|
1.7.1 | Bug fix - includes/excludes parameter in generic job |
|
1.7 | Add check policies for all libraries |
|
1.5.2 | Add fail on error param to global config |
|
1.5.1 | Update latest version of maven-release-plugin |
|
1.4 | Fix for proxy configuration |
|
1.3 |
|
|
1.2 | Shelved version. Disregard |
|
1.1 | Minor changes:
|
|
1.0 | First release of the plugin |
|