ivy:compileProject
+Full name:
+com.axonivy.ivy.ci:project-build-plugin:12.0.0: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.
+ - The goal is not marked as thread-safe and thus does not support parallel builds. +
- Since version:
6.0.0.
Required Parameters
+| Name | +Type | +Since | +Description |
|---|---|---|---|
<ivyVersion> |
+String |
+- |
+The ivy Engine version or version-range that must be used. Must be equal or higher than "12.0.0" Examples:
+ +
Default: 12.0.0User Property: ivy.engine.version |
Optional Parameters
+| Name | +Type | +Since | +Description |
|---|---|---|---|
<buildApplicationDirectory> |
+Path |
+- |
+Home application where the project to build and its dependencies will be temporary deployed. Default: ${project.build.directory}/ivyBuildApp |
<compilerOptions> |
+List<String> |
+8.0.3 |
+Define compiler options.
+ + <compilerOptions> <arg>-help<arg> </compilerOptions> |
<compilerSettings> |
+Path |
+8.0.3 |
+Define a compiler settings file to configure compilation warnings. Such file can be created in the Designer: Window - Preferences - Java - Compiler - Errors/Warnings, the corresponding file can be found in: designer-workspace/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.jdt.core.prefs
+ + If left empty the plugin will try to load the project specific settings file project/.settings/org.eclipse.jdt.core.prefs + + These settings are only active when compilerWarnings is set to true.Default: .settings/org.eclipse.jdt.core.prefsUser Property: ivy.compiler.settings |
<compilerWarnings> |
+boolean |
+8.0.3 |
+Set to false to disable compilation warnings.Default: trueUser Property: ivy.compiler.warnings |
<encoding> |
+String |
+6.3.1 |
+Specifies the default encoding for all source files. By default this is the charset of the JVM according to java.nio.charset.Charset.defaultCharset(). You may set it to another value like 'UTF-8'.User Property: ivy.compiler.encoding |
<engineCacheDirectory> |
+Path |
+- |
+Location where ivy engines in required version can be extracted to.
+ If the Engine does not yet exist, it can be automatically downloaded. Default: ${settings.localRepository}/.cache/ivyUser Property: ivy.engine.cache.directory |
<engineDirectory> |
+Path |
+- |
+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 If the Engine does not yet exist, it can be automatically downloaded. User Property: ivy.engine.directory |
<localRepository> |
+ArtifactRepository |
+- |
+No description. Default: ${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: falseUser Property: ivy.compiler.skip |
<skipScriptValidation> |
+boolean |
+8.0.3 |
+Set to false to perform the validation of ivyScript code within ivy processes.Default: falseUser Property: ivy.script.validation.skip |
<timeoutEngineStartInSeconds> |
+int |
+7.4.0 |
+Defines the timeout how long to wait for an engine start to compile. Default: 60User Property: ivy.compiler.engine.start.timeout |
<useLatestMinor> |
+Boolean |
+- |
+If set to true it will download the latest available minor version Default: falseUser Property: ivy.engine.version.latest.minor |
Parameter Details
<buildApplicationDirectory>
+Home application where the project to build and its dependencies will be temporary deployed.
+-
+
- Type:
java.nio.file.Path
+ - Required:
No
+ - Default:
${project.build.directory}/ivyBuildApp
<compilerOptions>
+Define compiler options.
+
+ <compilerOptions> <arg>-help<arg> </compilerOptions>
++ <compilerOptions> <arg>-help<arg> </compilerOptions>
-
+
- Type:
java.util.List<java.lang.String>
+ - Since:
8.0.3
+ - Required:
No
<compilerSettings>
+Define a compiler settings file to configure compilation warnings. Such file can be created in the Designer: Window - Preferences - Java - Compiler - Errors/Warnings, the corresponding file can be found in: designer-workspace/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.jdt.core.prefs
+
+ If left empty the plugin will try to load the project specific settings file project/.settings/org.eclipse.jdt.core.prefs +
+ These settings are only active when
++ If left empty the plugin will try to load the project specific settings file project/.settings/org.eclipse.jdt.core.prefs +
+ These settings are only active when
compilerWarnings is set to true.-
+
- Type:
java.nio.file.Path
+ - Since:
8.0.3
+ - Required:
No
+ - User Property:
ivy.compiler.settings
+ - Default:
.settings/org.eclipse.jdt.core.prefs
<compilerWarnings>
+Set to
+false to disable compilation warnings.-
+
- Type:
boolean
+ - Since:
8.0.3
+ - Required:
No
+ - User Property:
ivy.compiler.warnings
+ - Default:
true
<encoding>
+Specifies the default encoding for all source files. By default this is the charset of the JVM according to
+java.nio.charset.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.nio.file.Path
+ - 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.nio.file.Path
+ - 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 "12.0.0" 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
+ - Required:
Yes
+ - User Property:
ivy.engine.version
+ - Default:
12.0.0
<localRepository>
+No description.
+-
+
- Type:
org.apache.maven.artifact.repository.ArtifactRepository
+ - 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
<skipScriptValidation>
+Set to
+false to perform the validation of ivyScript code within ivy processes.-
+
- Type:
boolean
+ - Since:
8.0.3
+ - Required:
No
+ - User Property:
ivy.script.validation.skip
+ - Default:
false
<timeoutEngineStartInSeconds>
+Defines the timeout how long to wait for an engine start to compile.
+-
+
- Type:
int
+ - Since:
7.4.0
+ - Required:
No
+ - User Property:
ivy.compiler.engine.start.timeout
+ - Default:
60
<useLatestMinor>
+If set to true it will download the latest available minor version
+-
+
- Type:
java.lang.Boolean
+ - Required:
No
+ - User Property:
ivy.engine.version.latest.minor
+ - Default:
false