Fork me on GitHub
Built by Maven

ivy:deploy-iar

Full name:

com.axonivy.ivy.ci:project-build-plugin:9.4.1:deploy-iar

This plugin goal has been deprecated:

since 7.1.0. Use the deploy-to-engine goal instead.

Description:

Deploys an ivy-archive (IAR) to a running Axon Ivy Engine.

Command line invocation is supported. E.g.

mvn com.axonivy.ivy.ci:project-build-plugin:6.2.0:deploy-iar 
-Divy.deploy.iarFile=myProject.iar 
-Divy.deploy.engine.dir=c:/axonviy/engine
-Divy.deploy.engine.app=Portal

Attributes:

  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 6.1.0.

Required Parameters

Name Type Since Description
<ivyVersion> String 6.1.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: 9.4.0.
User property is: ivy.engine.version.

Optional Parameters

Name Type Since Description
<deployDirectory> String 6.1.0 The auto deployment directory of the engine. Must match the ivy engine system property 'deployment.directory'
Default value is: deploy.
User property is: ivy.deploy.dir.
<deployEngineDirectory> File 6.1.0 The path to the Axon Ivy Engine to which we deploy the IAR.
The path can reference a remote engine by using UNC paths e.g. \\myRemoteHost\myEngineShare
Default value is: ${ivy.engine.directory}.
User property is: ivy.deploy.engine.dir.
<deployIarFile> File 6.1.0 The IAR to deploy. By default the packed IAR from the IarPackagingMojo.GOAL is used.
Default value is: ${project.build.directory}/${project.artifactId}-${project.version}.iar.
User property is: ivy.deploy.iarFile.
<deployTimeoutInSeconds> Integer 6.1.0 The maximum amount of seconds that we wait for a deployment result from the engine
Default value is: 30.
User property is: ivy.deploy.timeout.seconds.
<deployToEngineApplication> String 6.1.0 The name of an ivy application to which the IAR is deployed.
Default value is: SYSTEM.
User property is: ivy.deploy.engine.app.
<engineCacheDirectory> File 6.1.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.1.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.
<skipDeploy> boolean 6.1.1 Set to true to skip the deployment to the engine.
Default value is: false.
User property is: ivy.deploy.skip.

Parameter Details

<deployDirectory>

The auto deployment directory of the engine. Must match the ivy engine system property 'deployment.directory'
  • Type: java.lang.String
  • Since: 6.1.0
  • Required: No
  • User Property: ivy.deploy.dir
  • Default: deploy

<deployEngineDirectory>

The path to the Axon Ivy Engine to which we deploy the IAR.
The path can reference a remote engine by using UNC paths e.g. \\myRemoteHost\myEngineShare
  • Type: java.io.File
  • Since: 6.1.0
  • Required: No
  • User Property: ivy.deploy.engine.dir
  • Default: ${ivy.engine.directory}

<deployIarFile>

The IAR to deploy. By default the packed IAR from the IarPackagingMojo.GOAL is used.
  • Type: java.io.File
  • Since: 6.1.0
  • Required: No
  • User Property: ivy.deploy.iarFile
  • Default: ${project.build.directory}/${project.artifactId}-${project.version}.iar

<deployTimeoutInSeconds>

The maximum amount of seconds that we wait for a deployment result from the engine
  • Type: java.lang.Integer
  • Since: 6.1.0
  • Required: No
  • User Property: ivy.deploy.timeout.seconds
  • Default: 30

<deployToEngineApplication>

The name of an ivy application to which the IAR is deployed.
  • Type: java.lang.String
  • Since: 6.1.0
  • Required: No
  • User Property: ivy.deploy.engine.app
  • Default: SYSTEM

<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.1.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.1.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.1.0
  • Required: Yes
  • User Property: ivy.engine.version
  • Default: 9.4.0

<skipDeploy>

Set to true to skip the deployment to the engine.
  • Type: boolean
  • Since: 6.1.1
  • Required: No
  • User Property: ivy.deploy.skip
  • Default: false