...
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? |
---|---|---|---|---|---|
checkPolicies | Whether to send the check policies request before updating WhiteSource.
| In case of policy violation, the scan will end with ERROR exit code POLICY_VIOLATION (-2). | The scan will end with SUCCESS. Inventory will be updated regardless of policy violations. No policy-related data will be generated. | False | No |
forceCheckAllDependencies | Force checks all dependencies. NOTE: Used only if checkPolicies and updateInventory is set to True. | Checks all policies for all dependencies introduced to the WhiteSource projects. | Checks only the new dependencies introduced to the WhiteSource projects. | False | No |
updateInventory | Whether to send an update request. | Sends an update request. | Sends a check policies request to WhiteSource without sending the update request; meaning the user will perform checkpolicies request without updating its inventory in WhiteSource. | True | No |
forceUpdate | Whether to update organization inventory regardless of policy violations. NOTE: Used only if checkPolicies is and updateInventory are both set to True. | Updates the project even if the checkPolicies step failed.
| In case of a policy violation:
| False | No |
forceUpdate.failBuildOnPolicyViolation | Determines whether the Unified Agent exit code will be the result of the policy check or the result of the scan. NOTE: Used only if forceUpdate is and updateInventory are both set to True. | The Unified Agent exit code will be the result of the policy check, meaning if there is a failure in checkpolicies the exit code is -2. | The Unified Agent exit code will be the result of the scan. (success or failure) | False | No |
...
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? |
---|---|---|---|---|---|
nuget.resolveDependencies | Whether to resolve NuGet packages.config and .csproj files. | Resolves NuGet packages.config and .csproj files. | Will not resolve NuGet packages.config and .csproj files. | True | No |
nuget.resolvePackagesConfigFiles | Whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No |
nuget.resolveCsProjFiles | Whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No |
nuget.preferredEnvironment | Defines the preferred NuGet restore command. Available values are nuget and dotnet. NOTE: This parameter will be used only if the nuget.runPreStep parameter is set to True. | N/A | N/A | No default | No |
nuget.packagesDirectory | Provides a path to the a directory where WhiteSource temporary files will be created (and removed at the end of a scan). This directory is not created by WhiteSource, but must be created by the user in advance. NOTE: Provide a directory with a short directoryname, in order to avoid errors related to the path size during the restore command. | N/A | N/A | No default | No |
nuget.ignoreSourceFiles | When using the dependency resolver, whether to include package dependencies or package dependencies + source files. NOTE: Only relevant when fileSystemScan is true. | Includes only package dependencies | Includes package dependencies and source files | True | No |
nuget.runPreStep | Whether to run nuget restore on found | Runs dotnet restore on csproj files and nuget restore on found packages.config files in order to download all dependencies to a temporary folder, scans this folder and deletes it after fetching the dependencies. | Will not run dotnet restore and nuget restore on found packages.config and csproj files. | False | No |
nuget.resolveNuspecFiles | Indicates whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No |
nuget.resolveAssetsFiles | Resolves obj/project.assets.json file for new .NET dependency management structure. | N/A | N/A | True | No |
...