apptools:deploy

Full name:

de.smartics.maven.plugin:apptools-maven-plugin:0.12.0:deploy

Description:

Deploy apps to the Confluence server.

Attributes:

Optional Parameters

Name Type Since Description
<acceptedFilenameExtensions> List 1.0 Specify the file name extensions to accept.

User property: apptools.acceptedFilenameExtensions, acceptedFilenameExtensions
<artifactServerId> String 1.0 The server ID to lookup additional credentials in the settings.xml. This is used when wagon needs extra authentication information.

User property: apptools.artifactServerId, artifactServerId
<artifacts> List 1.0 List of specification strings to locate artifacts on the artifact server and download them to the configured source repository.

User property: apptools.artifacts, artifacts
<checkEnablement> List 1.0 Specify the apps that need to be checked to be successfully enabled.

User property: apptools.check, check
<checkMaxCount> Integer 1.0 Specify the number of times should be conducted. The total wait for a finally failed enablement check would be checkWaitMs times checkMaxCount milliseconds.

User property: apptools.checkMaxCount, checkMaxCount

Defaults to '5'.
<checkWaitMs> Long 1.0 Specify the time the enablement check should wait if failed.

Defaults to '3000'.

User property: apptools.checkWait, checkWait
<deployedAppsMetadataServicePath> String 1.0 The path to the service on the server to fetch information about apps deployed on the server.

User property: atlassian.deployedAppsMetadataServicePath, deployedAppsMetadataServicePath

Defaults to '/rest/plugins/1.0/available/${plugin.key}-key'.
<deployedAppsServicePath> String 1.0 The path to the service on the server to fetch information about apps deployed on the server.

User property: atlassian.deployedAppsServicePath, deployedAppsServicePath

Defaults to '/rest/plugins/1.0/monitor/installed'.
<dryRun> boolean 1.0 A simple flag to run on the specified environment, but without actually deploying apps on the target.

User property: apptools.dryRun, dryRun


Default value is: false.
<enablementStateServicePath> String 1.0 The path to the checker service to check the status of a deployed app on the server.

User property: atlassian.enablementStateServicePath, enablementStateServicePath

Defaults to '/rest/plugins/1.0/${plugin.key}-key/summary'.
<excludes> List 1.0 Strings to match in app file names for exclusion. If empty, nothing is excluded. Suffix searches are supported by appending the dollar character ($) to the include string.

User property: apptools.excludes, excludes
<forceDeploy> boolean 1.0 Force the deployment of apps even if they are not newer than their deployed versions.

The deployment time returned form the application server is at day precision. Therefore all artifacts with the same snapshot version that are created on the same day of the last release are the same. To override you need to set this parameter to true.

User property: apptools.forceDeploy, forceDeploy
<ignoreNonEmptySourceFolder> boolean 1.0 If the source folder is not empty, the build will be terminated with an fail message. This prevents the user to deploy artifacts in an existing folder.

User property: apptools.ignoreNonEmptySourceFolder, ignoreNonEmptySourceFolder


Default value is: false.
<includes> List 1.0 Strings to match in app file names for inclusion. If empty, everything is included. Suffix searches are supported by appending the dollar character ($) to the include string.

User property: apptools.includes, includes
<order> List 1.0 Allows to impose a sort order on the list of artifacts to be deployed. The list represents stages (1, 2, 3, ...) that will deploy all matching artifacts.

User property: apptools.order, order
<password> String 1.0 The password of the user to authenticate to the remote server.

User property: apptools.password, password
<pluginsServicePath> String 1.0 The path to the service on the server.

User property: apptools.pluginsServicePath, pluginsServicePath

Defaults to '/rest/plugins/1.0/'.
<qualifierDatePattern> String 1.0 The pattern used to parse qualifier from the version reported by the deployed plugin. If the qualifier does match, the versions of the deployed plugin and the local apps are compared based on this date information.

User property: apptools.qualifierDatePattern, qualifierDatePattern

Defaults to 'yyyyMMdd.HHmmss'.
<requireReleases> boolean 1.0 If set to true only releases are considered. Otherwise snapshots are also taken into account.

User property: apptools.requireReleases, requireReleases


Default value is: false.
<rulesUri> String 1.0 URI of a ruleSet file containing the rules that control how to compare version numbers. The URI could be either a Wagon URI or a classpath URI (e.g. classpath:///package/sub/package/rules.xml).
User property is: rulesUri.
<serverId> String 1.0 The identifier for the server to fetch credentials in case username or password are not set explicitly. The credentials are used to connect to the REST API of the remote server.

User property: apptools.serverId, serverId
<serverUrl> String 1.0 The base server URL to locate services. This value is required, and is probably set via a profile in case more than one environment is targeted. Per convention, profiles containing a environment specific configuration, do not contain lower case letters.

User property: apptools.serverUrl, serverUrl
<settingsSecurityLocation> String 1.0 The location of the settings-security.xml.
Default value is: ${user.home}/.m2/settings-security.xml.
<skip> boolean 1.0 A simple flag to skip the deployment process.

User property: apptools.skip, skip


Default value is: false.
<sourceFolder> String 1.0 The folder with application files to process.

User property: apptools.source, source

Defaults to 'target/apps'.
<timeoutMs> Integer 1.0 The timeout in milliseconds for any connection issues accessing the remote service.

User property: apptools.timeout, timeout

Defaults to '5000'.
<tokenServicePath> String 1.0 The path to a service to fetch a token on the server.

User property: atlassian.tokenServicePath, tokenServicePath

Defaults to '/rest/plugins/1.0/'.
<useLatest> String 1.0 Override any specified versions in the POM with the latest version. Use SNAPSHOT for the latest snapshot release, RELEASE for the latest public release.

User property: apptools.useLatest, useLatest
<username> String 1.0 The name of the user to authenticate to the remote server.

User property: apptools.username, username
<verbose> boolean 1.0 A simple flag to log verbosely.

User property: apptools.verbose, verbose


Default value is: false.

Parameter Details

<acceptedFilenameExtensions>

Specify the file name extensions to accept.

User property: apptools.acceptedFilenameExtensions, acceptedFilenameExtensions

  • Type: java.util.List
  • Since: 1.0
  • Required: No

<artifactServerId>

The server ID to lookup additional credentials in the settings.xml. This is used when wagon needs extra authentication information.

User property: apptools.artifactServerId, artifactServerId

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<artifacts>

List of specification strings to locate artifacts on the artifact server and download them to the configured source repository.

User property: apptools.artifacts, artifacts

  • Type: java.util.List
  • Since: 1.0
  • Required: No

<checkEnablement>

Specify the apps that need to be checked to be successfully enabled.

User property: apptools.check, check

  • Type: java.util.List
  • Since: 1.0
  • Required: No

<checkMaxCount>

Specify the number of times should be conducted. The total wait for a finally failed enablement check would be checkWaitMs times checkMaxCount milliseconds.

User property: apptools.checkMaxCount, checkMaxCount

Defaults to '5'.

  • Type: java.lang.Integer
  • Since: 1.0
  • Required: No

<checkWaitMs>

Specify the time the enablement check should wait if failed.

Defaults to '3000'.

User property: apptools.checkWait, checkWait

  • Type: java.lang.Long
  • Since: 1.0
  • Required: No

<deployedAppsMetadataServicePath>

The path to the service on the server to fetch information about apps deployed on the server.

User property: atlassian.deployedAppsMetadataServicePath, deployedAppsMetadataServicePath

Defaults to '/rest/plugins/1.0/available/${plugin.key}-key'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<deployedAppsServicePath>

The path to the service on the server to fetch information about apps deployed on the server.

User property: atlassian.deployedAppsServicePath, deployedAppsServicePath

Defaults to '/rest/plugins/1.0/monitor/installed'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<dryRun>

A simple flag to run on the specified environment, but without actually deploying apps on the target.

User property: apptools.dryRun, dryRun

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

<enablementStateServicePath>

The path to the checker service to check the status of a deployed app on the server.

User property: atlassian.enablementStateServicePath, enablementStateServicePath

Defaults to '/rest/plugins/1.0/${plugin.key}-key/summary'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<excludes>

Strings to match in app file names for exclusion. If empty, nothing is excluded. Suffix searches are supported by appending the dollar character ($) to the include string.

User property: apptools.excludes, excludes

  • Type: java.util.List
  • Since: 1.0
  • Required: No

<forceDeploy>

Force the deployment of apps even if they are not newer than their deployed versions.

The deployment time returned form the application server is at day precision. Therefore all artifacts with the same snapshot version that are created on the same day of the last release are the same. To override you need to set this parameter to true.

User property: apptools.forceDeploy, forceDeploy

  • Type: boolean
  • Since: 1.0
  • Required: No

<ignoreNonEmptySourceFolder>

If the source folder is not empty, the build will be terminated with an fail message. This prevents the user to deploy artifacts in an existing folder.

User property: apptools.ignoreNonEmptySourceFolder, ignoreNonEmptySourceFolder

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

<includes>

Strings to match in app file names for inclusion. If empty, everything is included. Suffix searches are supported by appending the dollar character ($) to the include string.

User property: apptools.includes, includes

  • Type: java.util.List
  • Since: 1.0
  • Required: No

<order>

Allows to impose a sort order on the list of artifacts to be deployed. The list represents stages (1, 2, 3, ...) that will deploy all matching artifacts.

User property: apptools.order, order

  • Type: java.util.List
  • Since: 1.0
  • Required: No

<password>

The password of the user to authenticate to the remote server.

User property: apptools.password, password

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<pluginsServicePath>

The path to the service on the server.

User property: apptools.pluginsServicePath, pluginsServicePath

Defaults to '/rest/plugins/1.0/'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<qualifierDatePattern>

The pattern used to parse qualifier from the version reported by the deployed plugin. If the qualifier does match, the versions of the deployed plugin and the local apps are compared based on this date information.

User property: apptools.qualifierDatePattern, qualifierDatePattern

Defaults to 'yyyyMMdd.HHmmss'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<requireReleases>

If set to true only releases are considered. Otherwise snapshots are also taken into account.

User property: apptools.requireReleases, requireReleases

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

<rulesUri>

URI of a ruleSet file containing the rules that control how to compare version numbers. The URI could be either a Wagon URI or a classpath URI (e.g. classpath:///package/sub/package/rules.xml).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: rulesUri

<serverId>

The identifier for the server to fetch credentials in case username or password are not set explicitly. The credentials are used to connect to the REST API of the remote server.

User property: apptools.serverId, serverId

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<serverUrl>

The base server URL to locate services. This value is required, and is probably set via a profile in case more than one environment is targeted. Per convention, profiles containing a environment specific configuration, do not contain lower case letters.

User property: apptools.serverUrl, serverUrl

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<settingsSecurityLocation>

The location of the settings-security.xml.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: ${user.home}/.m2/settings-security.xml

<skip>

A simple flag to skip the deployment process.

User property: apptools.skip, skip

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

<sourceFolder>

The folder with application files to process.

User property: apptools.source, source

Defaults to 'target/apps'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<timeoutMs>

The timeout in milliseconds for any connection issues accessing the remote service.

User property: apptools.timeout, timeout

Defaults to '5000'.

  • Type: java.lang.Integer
  • Since: 1.0
  • Required: No

<tokenServicePath>

The path to a service to fetch a token on the server.

User property: atlassian.tokenServicePath, tokenServicePath

Defaults to '/rest/plugins/1.0/'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<useLatest>

Override any specified versions in the POM with the latest version. Use SNAPSHOT for the latest snapshot release, RELEASE for the latest public release.

User property: apptools.useLatest, useLatest

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<username>

The name of the user to authenticate to the remote server.

User property: apptools.username, username

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<verbose>

A simple flag to log verbosely.

User property: apptools.verbose, verbose

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false