Versions Compared

Key

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

...

Configuration File Parameter

Description and Expected Behavior

If True

If False

Default

Command Line Parameter Available?

gradle.ignoredConfigurations

 

Enables you to determine which dependency configurations to ignore in the scan.

The format is according to the following:

  • Exact configuration names to ignore.
    Values must be space-delimited.

For example: gradle.ignoredConfigurations= testCompileOnly testRuntimeOnly

ignores configurations named “testCompileOnly” and “testRuntimeOnly”.

  • Configurations can use regular expressions.

For example:gradle.ignoredConfigurations=.*test.* ignores all configuration names that contain the string "test".
NOTE: this paramter This parameter was previously named gradle.ignoredScopes

N/A

N/A

No default

No

gradle.resolveDependencies 

Whether to resolve Gradle resolve Gradle dependencies. Requires build.gradle or build.gradle.kts.

Resolves Gradle dependencies

Will not resolve Gradle dependencies

True
(except for when resolveAllDependencies=false

-gradle.resolveDependencies

gradle.runAssembleCommand

In case of a missing dependency, executes the 'gradle assemble' command 
NOTE: This command is executed only if `gradle.resolveDependencies` is True.

Executes the 'gradle assemble' command

Will not execute the 'gradle assemble' command

TrueignoreSourceFiles 

When using the dependency resolver, it will include only package dependencies, not source files.

NOTE: Only relevant when fileSystemScan is true.

The scan includes only package dependencies, not source files.

When using the dependency resolver, it will include package dependencies, plus source files.

False

No

gradle.runPreStep 

The Unified Agent will add additional jars to the customer's global cache.
In most Gradle versions the "gradle dependencies" command we run does this.

For each build.gradle file that the Unified Agent finds:

  1. Unified Agent will copy the Gradle project to a temporary system folder.

  2. Inside of each copied project's build.gradle file, the Unified Agent will add a task (named 'copyDependencies') in order to download the missing dependencies

  3. Unified Agent will run 'gradle copyDependencies' - this step will add the missing dependencies to the user's global cache

Will depend on Gradle dependencies to fill out missing cache dependencies.

False

No

gradle.ignoreSourceFiles 

When using the dependency resolver, it will include only package dependencies, not source files.

NOTE: Only relevant when fileSystemScan is true.

The scan includes only package dependencies, not source files.

When using the dependency resolver, it will include package dependencies, plus source files.

False

No

gradle.aggregateModules 

Whether to create a single project for all modules.

Creates a single project for all modules.

A project will be created for each module. The name of the project will be equal to the name of the module (if so, projectName will be ignored).

False

-gradle.aggregateModules

gradle.preferredEnvironment 

When set to 'wrapper', the Unified Agent will run the 'gradlew' wrapper command. If set to 'gradle', it will use the built-in gradle command.

N/A

N/A

gradle

No

gradle.localRepositoryPath

Paths to the gradle local repository.

For example, in Windows, the path can be defined as the following:
C:\\Users\\JSmith\\.gradle\\caches\\modules-2\\files-2.1

NOTE: From 19.5.3 it can handle a list of paths with comma/space-delimited.

N/A

N/A

No default

No

gradle.wrapperPath 

The path to the gradle wrapperaggregateModules 

Whether to create a single project for all modules.

Creates a single project for all modules.

A project will be created for each module. The name of the project will be equal to the name of the module (if so, projectName will be ignored).

False

-gradle.aggregateModules

gradle.preferredEnvironment 

When set to 'wrapper', the Unified Agent will run the 'gradlew' wrapper command. If set to 'gradle', it will use the built-in gradle command.

N/A

N/A

No default

No

gradle.downloadMissingDependencies 

Enables the user to disable downloading of missing dependencies in Gradle.

Enables the Unified Agent to download missing dependencies.

The Unified Agent will not download missing dependencies.

True

wrapper

No

gradle.additionalArguments 

Enables users to add additional arguments to the Unified Agent's existing commands. The existing commands are gradle dependencies or gradle wrapper dependencies.  This works the following way:

Users can provide any parameters starting with '-' or '--', and Unified Agent will add these at the end 

For example:

  • -Pbranch=dev -PbuildWithSources=false

  • --no-daemon --info

  • -Pbranch=dev -PbuildWithSources=false --no-daemon --info

N/A

N/A

No default

No

gradle.includedConfigurations

Enables you to determine which dependency configurations to include in the scan.

The format is according to the following:

  • Exact configuration names to include.

Values should be space-delimited.
For example:

gradle.includedConfigurations= compileOnly testCompileOnly

Includes configurations named “compileOnly” and “testCompileOnly”.

  • Configurations can include regular expressions.

For example:

gradle.includedConfigurations=.*Only.*

Includes all configuration names that contain the string "Only"
NOTE: this This parameter was previously named gradle.includedScopes 

N/A

N/A

No default

No

gradle.excludeModules 

Enables excluding specific modules in the Gradle scan. 

The format is according to the following:

  • Exact modules to exclude. Values should be space delimited. For example: gradle.excludeModules= Dev Prod - exclude scopes named 'Dev' and 'Prod'.

  • Regular expressions. For example: gradle.excludeModules=.*Dev.* includes all module names that contain (anywhere in their name) the string "Dev".

N/A

N/A

No default

No

gradle.includeModules 

Enables including specific modules in the Gradle scan.

The format is according to the following:

  • Exact modules to include. Values must be space delimited. For example: gradle.includeModules= Dev Prod - include modules named 'Dev' and 'Prod'.

  • Regular expressions. For example: gradle.includeModules=.*Dev.* includes all module names that contains these characters.

N/A

N/A

No default

No

gradle.innerModulesAsDependencies

When set to false, this parameter ignores and excludes all the modules dependencies from the resolution scan.

Includes all the modules dependencies from the resolution scan."

Ignores and excludes all the modules dependencies from the resolution scan.

True

No

...

Configuration File Parameter

Description and Expected Behavior

If True

If False

Default

Command Line Parameter Available?

conda.resolveDependencies 

Whether to resolve conda dependencies.

"environment.yml" is required.

Resolves conda dependencies.

Will not resolve conda dependencies.

FalseTrue

No

Go

For more information regarding Go integration, refer here.

...

Configuration File Parameter

Description and Expected Behavior

If True

If False

Default

Command Line Parameter Available?

go.resolveDependencies 

Whether to resolve Go dependencies managed by one of the following package managers:

  • dep

  • godep

  • vndr

  • gogradlego

  • govendor

  • gopm

  • glide

Will resolve Go projects.

Will not resolve Go projects.

True
(except for when resolveAllDependencies=false )

No

go.collectDependenciesAtRuntime 

Whether to collect Go dependencies at runtime (similar to the 'runPreStep' parameter for the other languages).

When set to True, refer here for an explanation.

Will run the command relevant to the select dependency manager.

Will not run the command

False

No

go.dependencyManager 

Determines the Go dependency manager for use when scanning a Go project. Valid values are:

  • dep

  • godep

  • vndr

  • gogradlego

  • govendor

  • gopm

  • glide

If left empty, the Unified Agent will first try to resolve the dependencies using the first package manager from this list. If it fails, it continues and tries the next one until it succeeds.

N/A

N/A

No default (empty)

No

go.ignoreSourceFiles 

When using the dependency resolver, it will only include package dependencies, not source files.

NOTE: Only relevant when fileSystemScan is true.

Will ignore .go. files from scan.

Will not ignore .go. files from the scan.

False

No

go.glide.ignoreTestPackages 

When using the Glide resolver, whether to ignore test packages defined in the 'testImport' section of the 'glide.yaml' file.

Ignore test packages from the scan.

Does not ignore the mentioned test packages from the scan.

True

No

go.gogradlego.enableTaskAlias 

Enables/disables task aliasing for gogradlego

Set to True when using gogradle go dependency manager and the gradle argument (in 'gradle.properties') includes 'gograld.alias=true'. 

Enables task aliasing for gogradlego.

Disables task aliasing for gogradlego.

False

No

Modules

Configuration File Parameter

Description and Expected Behavior

If True

If False

Default

Command Line Parameter Available?

go.modules.resolveDependencies

Whether to resolve Go Modules dependencies.

Resolves Go Modules dependencies.

Will not resolve Go Modules dependencies.

True

No

go.modules.ignoreSourceFiles

Will perform package manager based dependencies resolution only or include source files as well.

NOTE: Only relevant when fileSystemScan is true.

Will ignore Go source files during the scan.

Will not ignore Go source file.

True

No

go.modules.removeDuplicateDependencies

Whether to remove duplicate dependencies during Go Modules dependency resolution.

Removes duplicate dependencies during Go Modules dependency resolution.

Includes duplicate dependencies during Go Modules dependency resolution.

True

No

go.modules.includeTestDependencies

Whether to scan Go Modules project test dependencies.

Scans Go Modules project test dependencies.

Will not scan Go Modules project test dependencies.

False

No

...