phonegap-build:build

Full name:

com.github.chrisprice:phonegap-build-maven-plugin:0.0.8-SNAPSHOT:build

Description:

Compress the exploded package to a zip using the specified filters. Add in the config.xml from src/main/phonegap-build/. The compressed artifact will then be uploaded to either a pre-existing cloud app instance or a new one depending on whether a stored app id can be found.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
androidCertificateAlias String - Android keystore certificate alias. Deprecated - use androidServer instead.
androidCertificatePassword String - Android certificate password. Deprecated - use androidServer instead.
androidKeyId Integer - Android key id (used in preference to uploading an android key)
androidKeystore File - Android keystore. Deprecated - use androidServer instead.
androidKeystorePassword String - Android keystore password. Deprecated - use androidServer instead.
androidServer String - Android certificate server id (used in preference to androidCertificate*)
androidSign boolean - Enable android signing.
Default value is: false.
appId Integer - App id (used in preference to creating a new app)
appTitle String - The application title, defaults to the final name of the app but will be overridden by any title specified in the config file.
configFile File - Configuration file.
iOsCertificate File - iOS p12 certificate. Deprecated - use iOsServer instead.
iOsCertificatePassword String - iOS certificate password. Deprecated - use iOsServer instead.
iOsKeyId Integer - iOS key id (used in preference to uploading an ios key)
iOsMobileProvision File - iOS mobileprovision file
iOsServer String - iOS certificate server id (used in preference to iOsCertificate*)
keys String - A comma delimited string of artifact co-ordinates used to filter the dependencies list for key packages. The co-ordinates should be of the form groupId:artifactId.
password String - PhoneGap Build password. Deprecated, use server instead.
platforms String[] - The platforms to build for. Defaults to android, blackberry, ios, symbian, webos and winphone
preparedPackage File - A ready-to-upload zip file in case you want to control package content. Thus, you can filter some resources like the config.xml before uploading to PhoneGap.
server String - The id of the server to pull the credentials from (takes precedent over username/password).
username String - PhoneGap Build username. Deprecated, use server instead.
warDirectory File - Exploded WAR directory
warExcludes String[] - A set of file patterns to exclude from the zip. Defaults to "WEB-INF/**/*", "WEB-INF"
warIncludes String[] - A set of file patterns to include in the zip.
zipFile String - Zip file.

Parameter Details

androidCertificateAlias:

Android keystore certificate alias. Deprecated - use androidServer instead.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.android.certificate.alias}

androidCertificatePassword:

Android certificate password. Deprecated - use androidServer instead.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.android.certificate.password}

androidKeyId:

Android key id (used in preference to uploading an android key)
  • Type: java.lang.Integer
  • Required: No

androidKeystore:

Android keystore. Deprecated - use androidServer instead.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/phonegap-build/android.keystore

androidKeystorePassword:

Android keystore password. Deprecated - use androidServer instead.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.android.keystore.password}

androidServer:

Android certificate server id (used in preference to androidCertificate*)
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.android.server}

androidSign:

Enable android signing.
  • Type: boolean
  • Required: No
  • Default: false

appId:

App id (used in preference to creating a new app)
  • Type: java.lang.Integer
  • Required: No

appTitle:

The application title, defaults to the final name of the app but will be overridden by any title specified in the config file.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.build.finalName}

configFile:

Configuration file.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/phonegap-build/config.xml

iOsCertificate:

iOS p12 certificate. Deprecated - use iOsServer instead.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/phonegap-build/ios.p12

iOsCertificatePassword:

iOS certificate password. Deprecated - use iOsServer instead.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.ios.certificate.password}

iOsKeyId:

iOS key id (used in preference to uploading an ios key)
  • Type: java.lang.Integer
  • Required: No

iOsMobileProvision:

iOS mobileprovision file
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/phonegap-build/ios.mobileprovision

iOsServer:

iOS certificate server id (used in preference to iOsCertificate*)
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.ios.server}

keys:

A comma delimited string of artifact co-ordinates used to filter the dependencies list for key packages. The co-ordinates should be of the form groupId:artifactId.
  • Type: java.lang.String
  • Required: No

password:

PhoneGap Build password. Deprecated, use server instead.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.password}

platforms:

The platforms to build for. Defaults to android, blackberry, ios, symbian, webos and winphone
  • Type: java.lang.String[]
  • Required: No

preparedPackage:

A ready-to-upload zip file in case you want to control package content. Thus, you can filter some resources like the config.xml before uploading to PhoneGap.
  • Type: java.io.File
  • Required: No

server:

The id of the server to pull the credentials from (takes precedent over username/password).
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.server}

username:

PhoneGap Build username. Deprecated, use server instead.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phonegap-build.username}

warDirectory:

Exploded WAR directory
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/${project.build.finalName}

warExcludes:

A set of file patterns to exclude from the zip. Defaults to "WEB-INF/**/*", "WEB-INF"
  • Type: java.lang.String[]
  • Required: No

warIncludes:

A set of file patterns to include in the zip.
  • Type: java.lang.String[]
  • Required: No

zipFile:

Zip file.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.build.finalName}.zip