Fork me on GitHub

project-build:compileProject

Full name:

com.axonivy.ivy.ci:project-build-plugin:7.0.4:compileProject

Description:

Compiles an ivy Project with an ivyEngine.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 6.0.0.

Required Parameters

Name Type Since Description
ivyVersion String 6.0.0 The ivy Engine version or version-range that must be used. Must be equal or higher than MINIMAL_COMPATIBLE_VERSION Examples:
  • "6.1.2" means ivyVersion = 6.1.2
  • "[6.1.0,7.0.0)" means 6.1.0 <= ivyVersion < 7.0.0
  • "(6.0.0,]" means ivyVersion > 6.0.0

Default value is: 7.0.0.
User property is: ivy.engine.version.

Optional Parameters

Name Type Since Description
buildApplicationDirectory File 6.0.0 Home application where the project to build and its dependencies will be temporary deployed.
Default value is: ${project.build.directory}/ivyBuildApp.
encoding String 6.3.1 Specifies the default encoding for all source files. By default this is the charset of the JVM according to Charset.defaultCharset(). You may set it to another value like 'UTF-8'.
User property is: ivy.compiler.encoding.
engineCacheDirectory File 6.0.0 Location where ivy engines in required version can be extracted to.

If the Engine does not yet exist, it can be automatically downloaded.


Default value is: ${settings.localRepository}/.cache/ivy.
User property is: ivy.engine.cache.directory.
engineDirectory File 6.0.0 Location where an unpacked (may pre-configured) ivy Engine in the required version exists.

If parameter is not set it will be a sub-directory of the engineCacheDirectory.

If the Engine does not yet exist, it can be automatically downloaded.


User property is: ivy.engine.directory.
localRepository ArtifactRepository 6.0.0 (no description)
Default value is: ${localRepository}.
skipCompilation boolean 6.1.0 Set to true to bypass the generation of ivy data classes+webservice processes and compilation of java sources.
Default value is: false.
User property is: ivy.compiler.skip.
timeoutEngineStartInSeconds int 7.0.4 (Leading Edge 7.4.0) Defines the timeout how long to wait for an engine start to compile.
Default value is: 60.
User property is: ivy.compiler.engine.start.timeout.

Parameter Details

buildApplicationDirectory:

Home application where the project to build and its dependencies will be temporary deployed.
  • Type: java.io.File
  • Since: 6.0.0
  • Required: No
  • Default: ${project.build.directory}/ivyBuildApp

encoding:

Specifies the default encoding for all source files. By default this is the charset of the JVM according to Charset.defaultCharset(). You may set it to another value like 'UTF-8'.
  • Type: java.lang.String
  • Since: 6.3.1
  • Required: No
  • User Property: ivy.compiler.encoding

engineCacheDirectory:

Location where ivy engines in required version can be extracted to.

If the Engine does not yet exist, it can be automatically downloaded.

  • Type: java.io.File
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.cache.directory
  • Default: ${settings.localRepository}/.cache/ivy

engineDirectory:

Location where an unpacked (may pre-configured) ivy Engine in the required version exists.

If parameter is not set it will be a sub-directory of the engineCacheDirectory.

If the Engine does not yet exist, it can be automatically downloaded.

  • Type: java.io.File
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.directory

ivyVersion:

The ivy Engine version or version-range that must be used. Must be equal or higher than MINIMAL_COMPATIBLE_VERSION Examples:
  • "6.1.2" means ivyVersion = 6.1.2
  • "[6.1.0,7.0.0)" means 6.1.0 <= ivyVersion < 7.0.0
  • "(6.0.0,]" means ivyVersion > 6.0.0
  • Type: java.lang.String
  • Since: 6.0.0
  • Required: Yes
  • User Property: ivy.engine.version
  • Default: 7.0.0

localRepository:

(no description)
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Since: 6.0.0
  • Required: No
  • Default: ${localRepository}

skipCompilation:

Set to true to bypass the generation of ivy data classes+webservice processes and compilation of java sources.
  • Type: boolean
  • Since: 6.1.0
  • Required: No
  • User Property: ivy.compiler.skip
  • Default: false

timeoutEngineStartInSeconds:

Defines the timeout how long to wait for an engine start to compile.
  • Type: int
  • Since: 7.0.4 (Leading Edge 7.4.0)
  • Required: No
  • User Property: ivy.compiler.engine.start.timeout
  • Default: 60