Plugin Documentation

Goals available for this plugin:

GoalDescription
android:apkCreates the apk file. By default signs it with debug keystore.
Change that by setting configuration parameter <sign><debug>false</debug></sign>.
android:apklibCreates the apklib file.
apklib files do not generate deployable artifacts.
android:cleanNo description.
android:deployDeploys the built apk file, or another specified apk, to a connected device.
Automatically performed when running mvn integration-test (or mvn install) on a project with instrumentation tests.
android:deploy-dependenciesDeploys all directly declared dependencies of <type>apk</type> in this project's pom.
Usually used in a project with instrumentation tests, to deploy the apk to test onto the device before running the deploying and running the instrumentation tests apk.
Automatically performed when running mvn integration-test (or mvn install) on a project with instrumentation tests.
android:dexConverts compiled Java classes to the Android dex format.
android:emmaAfter compiled Java classes use emma tool
android:emulator-startEmulatorStartMojo can start the Android Emulator with a specified Android Virtual Device (avd).
android:emulator-stopEmulatorStartMojo can stop the Android Emulator with a specified Android Virtual Device (avd).
android:emulator-stop-allEmulatorStopeAllMojo will stop all attached devices.
android:generate-sourcesGenerates R.java based on resources specified by the resources configuration parameter.
Generates java files based on aidl files.

android:helpDisplay help information on android-maven-plugin.
Call 
  mvn android:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
android:instrumentRuns the instrumentation apk on device.
android:internal-integration-testInternal. Do not use.
Called automatically when the lifecycle reaches phase integration-test. Figures out whether to call goals in this phase; and if so, calls android:instrument.
android:internal-pre-integration-testInternal. Do not use.
Called automatically when the lifecycle reaches phase pre-integration-test. Figures out whether to call goals in this phase; and if so, calls android:deploy-dependencies and android:deploy.
android:manifest-updateUpdates various version attributes present in the AndroidManifest.xml file.
android:ndk-buildNo description.
android:proguardProcesses both application and dependency classes using the ProGuard byte code obfuscator, minimzer, and optimizer. For more information, see https://proguard.sourceforge.net.
android:pullCopy file or directory from all the attached (or specified) devices/emulators.
android:pushCopy file to all the attached (or specified) devices/emulators.
android:redeployRedeploys the built apk file, or another specified apk, to a connected device. This simply tries to undeploy the APK and re-deploy it.
android:runRuns the first Activity shown in the top-level launcher as determined by its Intent filters.

Android provides a component-based architecture, which means that there is no "main" function which serves as an entry point to the APK. There's an homogeneous collection of Activity(es), Service(s), Receiver(s), etc.

The Android top-level launcher (whose purpose is to allow users to launch other applications) uses the Intent resolution mechanism to determine which Activity(es) to show to the end user. Such activities are identified by at least:

  • Action type: android.intent.action.MAIN
  • Category: android.intent.category.LAUNCHER


And are declared in AndroidManifest.xml as such:

<activity android:name=".ExampleActivity">
    <intent-filter>
        <action android:name="android.intent.action.MAIN" />
        <category android:name="android.intent.category.LAUNCHER" />
    </intent-filter>
</activity>

This Mojo will try to to launch the first activity of this kind found in AndroidManifest.xml. In case multiple activities satisfy the requirements listed above only the first declared one is run. In case there are no "Launcher activities" declared in the manifest or no activities declared at all, this goal aborts throwing an error.

The device parameter is taken into consideration so potentially the Activity found is started on all attached devices. The application will NOT be deployed and running will silently fail if the application is not deployed.

android:undeployUndeploys the built apk file, or another specified apk, from a connected device.
android:unpackUnpack libraries code and dependencies into target. This can be useful for using the proguard maven plugin to provide the input jars. Although it is encouraged to use the proguard mojo of the android maven plugin.
android:zipalignZipalignMojo can run the zipalign command against the apk.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven[3.0.3,)
JDK1.6
MemoryNo minimum requirement.
Disk SpaceNo minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>com.jayway.maven.plugins.android.generation2</groupId>
          <artifactId>android-maven-plugin</artifactId>
          <version>3.2.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.jayway.maven.plugins.android.generation2</groupId>
        <artifactId>android-maven-plugin</artifactId>
        <version>3.2.0</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"