Versions Compared

Old Version 51

changes.mady.by.user Michael Hollander

Saved on

compared with

New Version 52

changes.mady.by.user Tsur Rothfeld

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Type

Description

Required?

Default

migrationMode.changeType

String

Type of change to perform as part of the migration.

There are two possible values:

  • inheritance - The migrating repositories will inherit from the global configuration

  • deletion - The .whitesource file (if found) will be removed from the migrating repositories. Note the following:

    • This should only be used when repoConfigMode in the global-config.json file has the value noWhitesourceFile. Otherwise, no migration will be performed.

    • In WhiteSource for Bitbucket Server, the deletion option is not available. You will need to manually delete the .whitesource file for each migrated repository.

No

inheritance

migrationMode.openPR
(WhiteSource for GitHub Enterprise, WhiteSource for GitHub.com, and WhiteSource for Bitbucket Server/Data Center)

migrationMode.openMR
(WhiteSource for GitLab)

Boolean

Whether an onboarding PR/MR should be created for the migrating repositories.

NOTE: When set to false, every migrating repository that currently contains a .whitesource file will trigger an automatic scan after these are migrated. This may affect overall performance of the integration depending on how many migrating repositories you have.

No

true

migrationMode.fixInheritance

Boolean

This parameter can be used in case the Global Configuration repository was moved or renamed since the initial integration.

When enabled, the migration will update existing inheritedFrom parameter values in repo-level .whitesource configuration files, to the correct whitesource-config repository.

No

false

migrationMode.triggerScan

Boolean

Control whether the migration should trigger a scan after completion.

NOTE: this parameter is relevant only when using migrationMode.changeType=inheritance.

No

true

includeRepos

Array

Provide a list of specific full repository names (owner/repo_name) on which the migration should run.

NOTE: You cannot use includeRepos together with excludeRepos as part of a migration.

Example:

Code Block
"includeRepos": ["whitesource/unified-agent-distribution", "whitesource/jenkins-whitesource-plugin"]

No

Empty

excludeRepos

Array

Provide a list of specific full repository names (owner/repo_name) on which the migration should not run.

NOTE: You cannot use excludeRepos together with includeRepos as part of a migration.

Example:

Code Block
"excludeRepos": ["whitesource/unified-agent-distribution"]

No

Empty

Defining Global CVSS Scoring Methods

Users can define the CVSS scoring method on the Global Configuration level. For example, if you select CVSS 2.0, both Issues as well as Check Runs will always display CVSS2 score information.
For this feature to work, the Global Repo Configuration must be implemented as part of your WhiteSource integration.

NOTE: The WhiteSource Core inventory and its associated reports will still reflect the original behavior of showing CVSS Score 3.0 by default (with CVSS2 as a fallback).

global-config.json

For more information on the global-config.json file, see here. The following parameter can be provided to enable/disable this feature:

Parameter 

Type

Description

Required 

Default

cvssDisplayMode

String

Two different values can be provided for this parameter:

  • "2.0" - Issues and WhiteSource Security Checks will display only CVSS 2.0 scoring information.

  • "3.0" - Issues and WhiteSource Security Checks will display only CVSS 3.0 scoring information, and fallback to 2.0 when no 3.0 is available.

NOTE: In order to maintain backwards compatibility, the default behavior in case the cvssDisplayMode parameter is not provided will be showing CVSS Score 3.0 information with 2.0 score display as a fallback in case no 3.0 info is available.

Examples:

  • "cvssDisplayMode": "2.0"

  • "cvssDisplayMode": "3.0"

Yes

3.0