Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simpligility/maven-android-sdk-deployer

A tool to install components of the Android SDK into a Maven repository or repository manager to use with the Android Maven Plugin, Gradle and other tools.
https://github.com/simpligility/maven-android-sdk-deployer

Last synced: 29 days ago
JSON representation

A tool to install components of the Android SDK into a Maven repository or repository manager to use with the Android Maven Plugin, Gradle and other tools.

Awesome Lists containing this project

README 

        
Maven Android SDK Deployer

--------------------------



[![Build Status](https://travis-ci.org/simpligility/maven-android-sdk-deployer.png)](https://travis-ci.org/simpligility/maven-android-sdk-deployer.png)



Original author including numerous fixes and changes:



Manfred Moser [email protected]  at [simpligility technologies inc](http://www.simpligility.com)



Project maintainers:



- Manfred Moser [email protected]  at [simpligility technologies inc](http://www.simpligility.com)

- Benoit Billington https://github.com/Shusshu



Contributors (historical order..):



- Hugo Josefson  - properties plugin usage

- Jake Wharton  - 3.2, compatibility v13 and 4.0.3 support

- https://github.com/holdensmagicalunicorn - spelling fix

- Guto Maia - initial USB add on support

- Lorenzo Villani - initial 4.0 support

- Paul Merlin http://eskatos.github.com - Google Analytics extra

- Matteo Panella  - Google AdMobs extra, support for 4.1

- Benoit Billington https://github.com/Shusshu Google Cloud Messaging Client and Server, annotations.jar, 4.2, 4.3, 4.4, APK Expansion, Licensing, 4.4W, L, 5.0, MultiDex, MNC

- Michael Lake https://github.com/mlake support for Javadoc attachment for platforms

- Nic Strong http://www.codepoets.co.nz Google Play Services (gms)

- Matias Dumrauf http://github.com/mdumrauf - Compatibility v7 library support, Google Analytics support for V1 and V2

- https://github.com/skyisle minor documentation fix                            

- Viacheslav Rodionov https://github.com/bepcyc AdbMob update

- David Venable https://github.com/dlvenable admob update

- Jenny Loomis Williamson https://github.com/jloomis fix for deployment

- James Wald https://github.com/jameswald configured groupId and artifactId for support libraries

- Thomas Prochazka https://github.com/tprochazka javadoc attachment, fix for artifactIds

- Shairon Toledo http://www.hashcode.eti.br doc update

- Kohsuke Kawaguchi http://kohsuke.org/ webdav support for deployment

- Lars Hoss http://cv.woeye.net/ v7 appcompat library support

- Nemanja Nedic https://github.com/nemanjanedic appcompat javadoc fix

- Yuvi Panda https://github.com/yuvipanda appcompat fix

- Sebastian Roth https://github.com/ened added missing google-apis-18 add-on

- Andreas Gawelczyk https://github.com/andreas- - Compatibility v7 mediarouter

- Hoyt Summers Pittman https://github.com/secondsun - Google API 19, google play services to > Froyo, update android-maven-plugin

- Aaron Alaniz https://github.com/aaalaniz - Google Glass Development Kit

- Heath Borders https://github.com/hborders - documentation update

- Hoyt Summers Pittman https://github.com/secondsun - javadoc fix for Java 8 support

- Dieter Adriaenssens https://github.com/ruleant

- Quentin Rousseau https://github.com/kwent

- Mingfai Ma https://github.com/mingfai

- Raphael Ackermann https://github.com/rtack sdk 21 fix for apklibs

- Daniel Passos https://github.com/danielpassos - Google API 24

- Edda Björk Konráðsdóttir, Android 7.1 API 25

- Alexander Berezovsky https://github.com/alezandr - Android API 15 & 25 sources

- Alix Warnke, Android 8.0 API 26

- Zsolt Fatér, https://github.com/zsoltii - Android 8.1 API 27, Android 9.0 API 28, adding repositories/extras-m2repository, fixes for add-ons



The Maven Android SDK Deployer is a helper maven project that can be

used to install the libraries necessary to build Android applications

with Maven and the Android Maven Plugin directly from your local

Android SDK installation. 



The dependencies can also be used from other build tools such as Gradle, Ant/Ivy or SBT.



ATTENTION!  Currently some android.jar artifacts are available in

Maven central and unless you use maps or usb related dependencies,

android 3.0+, the compatibility library jar files or insist on using

the original jar files from the local SDK install, you might not need

this tool anymore.



You will however need this tool to access the latest Android 4.2

release or to work around bugs like missing JSON libraries in some

older artifacts deployed to Maven central. If you use this tool make

sure your dependencies are as documented here.



The android.jar artifacts in Maven central are available with the

groupId `com.google.android`, whereas this tool uses groupId `android` to

avoid overlap.



How to Use

----------



Download the latest Android SDK from

http://developer.android.com/sdk/index.html following the instructions

there.



Apache Maven 3.1.1 or higher is required!

 

- For the default usage of the deployer install **all platforms and

add-on apis**, ensure that all folder in the platforms folder have

names like android-3, android-4 and so on.  



- If you find names using the platform version (e.g. 15) in the folder

name reinstall that platform from the android tool.



- In a similar manner the folder names in add-ons have to use the

pattern addon-google_apis-google-3 up to addon-google_apis-google-15.



- If the folder names are different reinstall the add-ons as well



Set up the environment variable ANDROID_HOME to contain the absolute

 folder you just installed the SDK to (e.g. under bash: export

 ANDROID_HOME=/opt/android_sdk_linux) and ensure that the folder for

 ANDROID_HOME and all files within are readable by the current user



Run the command



    mvn install



in the root folder of this project (same as README you are just

reading) to install all platforms and add-on apis



To install only a certain sdk level use



    mvn install -P 2.1

    mvn install -P 2.2

    mvn install -P 2.3.3

    mvn install -P 3.0

    mvn install -P 3.1

    mvn install -P 3.2

    mvn install -P 4.0

    mvn install -P 4.0.3

    mvn install -P 4.1

    mvn install -P 4.2

    mvn install -P 4.3

    mvn install -P 4.4

    mvn install -P 4.4W

    mvn install -P 5.0

    mvn install -P 5.1

    mvn install -P 6.0

    mvn install -P 7.0

    mvn install -P 7.1

    mvn install -P 8.0

    mvn install -P 8.1

    mvn install -P 9.0

    mvn install -P MNC



As a result you should find the android.jar and maps.jar and a number of other

libraries in your users local repository (~/.m2/repository/) and you can therefore

use the following dependencies in your project



For the core platforms providing the Android API use



```xml



  android

  android

  x.y.z

  provided



```

with versions of 



```xml

  2.1_r3

  2.2_r3

  2.3.3_r2

  3.0_r2

  3.1_r3

  3.2_r1

  4.0_r4

  4.0.3_r5

  4.1.2_r5

  4.2.2_r3

  4.3.1_r3

  4.4.2_r4

  4.4W.2_r2

  5.0_r2

  5.1_r1

  6.0_r3

  7.0_r2

  7.1.1_r3

  8.0.0_r2

  8.1.0_r3

  9_r6

```



For the maps add ons use a dependency



```xml



  com.google.android.maps

  maps

  x.y.z

  provided



```



with versions of 7_r1, 8_r2, 11_r1, 12_r1, 

13_r1, 14_r2, 15_r2, 16_r3, 17_r3, 18_r3, 19_r10, 21_r1



For the usb add on



```xml



  com.android.future

  usb

  x.y.z

  provided



```



with versions of 10_r2, 12_r1, 13_r1, 14_r2, 15_r2, 16_r3, 17_r3, 

18_r3, 19_r4, 21_r1



Android SDK Maven Repositories



The Maven repositories from the Android SDK for Google and Android are copied to the local repository or uploaded to 

a remote repository manager just like they are in the SDK and contain all components from these repositories. 

Currently they are in the package space com.android.support and com.google.android and present the preferred components 

for usage. Specifically the various compatibility and support libraries as Android Archives:



```xml



  com.android.support

  appcompat-v7

  x.y.z

  aar



```



with versions 18.0.0, 19.0.0, 19.0.1, 19.1.0, 20.0.0, 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  cardview-v7

  x.y.z

  aar



```



with versions 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  gridlayout-v7

  x.y.z

  aar



```



with versions 13.0.0, 18.0.0, 19.0.0, 19.0.1, 19.1.0, 20.0.0, 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  leanback-v17

  x.y.z

  aar



```



with versions 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  mediarouter-v7

  x.y.z

  aar



```



with versions 18.0.0, 19.0.0, 19.0.1, 19.1.0, 20.0.0, 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  palette-v7

  x.y.z

  aar



```



with versions 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  recyclerview-v7

  x.y.z

  aar



```



with versions 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  support-v13

  x.y.z

  aar



```



with versions 13.0.0, 18.0.0, 19.0.0, 19.0.1, 19.1.0, 20.0.0, 21.0.0, 21.0.2, 21.0.3



```xml



  com.android.support

  support-v4

  x.y.z

  aar



```



with versions 13.0.0, 18.0.0, 19.0.0, 19.0.1, 19.1.0, 20.0.0, 21.0.0, 21.0.2, 21.0.3



Besides the artifacts provided for the compatibility libraries from the Android SDK Maven Repositories 

the following are also provided. 

For the compatibility extra (ATTENTION! Do NOT use provided scope!!) 



```xml



  android.support

  compatibility-v4

  21.0.3



  android.support

  compatibility-v13

  21.0.3



```



If you find that the above `` fails due to conflicts, your project and it's dependencies may 

both depend on the compatibility extra.  The first option is to add an `` 

clause to each dependency that uses the library, 

as [described here](https://groups.google.com/forum/#!msg/actionbarsherlock/2cLR48IArck/U8--60QxeTkJ).  This works 

with command line builds but it may not work with your IDE.



If you have problems with ``, another option is to override the ``, ``, and `` 

properties used by the deployer to match Google's published library.



Then override `support-v4` or `support-v13` during installation:



    mvn install -Dextras.compatibility.v4.groupid=com.google.android \

                -Dextras.compatibility.v4.artifactid=support-v4 \

                -Dextras.compatibility.v4.version.prefix=r



    mvn install -Dextras.compatibility.v13.groupid=com.google.android \

                -Dextras.compatibility.v13.artifactid=support-v13 \

                -Dextras.compatibility.v13.version.prefix=r



In order to use v7 extra, both dependencies (apklib & jar) are needed



```xml



  android.support

  compatibility-v7

  21.0.3

  apklib



  android.support

  compatibility-v7

  21.0.3

  jar



```



For the v7 appcompat library additional dependencies (apklib & jar) are required (Deprecated)



```xml



  android.support

  compatibility-v7-appcompat

  21.0.3

  apklib



  android.support

  compatibility-v7-appcompat

  21.0.3

  jar



```



The v7 appcompat library an Android Archive dependency (aar) as provided by the Android SDK Google repository



```xml



  com.android.support

  appcompat-v7

  21.0.3

  aar



```

with versions 18.



For the v7 gridlayout library additional dependencies (apklib & jar) are required (Deprecated)



```xml



  android.support

  compatibility-v7-gridlayout

  21.0.3/version>

  apklib



  android.support

  compatibility-v7-gridlayout

  20.0.0

  jar



```



For the v7 gridlayout library an additional dependency (aar) is required



```xml



  com.android.support

  gridlayout-v7

  21.0.0-rc1

  aar



```



For the v7 mediarouter library additional dependencies (apklib & jar) are required (Deprecated)



```xml



  android.support

  compatibility-v7-mediarouter

  20.0.0

  apklib



  android.support

  compatibility-v7-mediarouter

  20.0.0

  jar



```



For the uiautomator jar



```xml



  android.test.uiautomator

  uiautomator

  4.1.2_r4

  provided



````



with versions 4.1.2_r4, 4.2.2_r2, 4.3_r2, 4.4.2_r3

    

For the Google Play Services extra (ATTENTION! Do NOT use provided scope!!) (Deprecated)



```xml



  com.google.android.gms

  google-play-services

  16.0.0

  apklib



  com.google.android.gms

  google-play-services

  16.0.0

  jar



```



For the Google Play Services extra (ATTENTION! Do NOT use provided scope!!)



```xml



  com.google.android.gms

  play-services

  4.4.52

  aar



```



For the Google Play APK Expansion extra (ATTENTION! Do NOT use provided scope!!)



```xml



  com.google.android.apk.expansion

  play-apk-expansion-downloader

  3.0.0

  apklib



  com.google.android.apk.expansion

  play-apk-expansion-zip

  3.0.0

  apklib



```



For the Google Play Licensing extra (ATTENTION! Do NOT use provided scope!!)



```xml



  com.google.android.licensing

  play-licensing

  2.0.0

  apklib



```



To install only a specific module use



    mvn clean install -N



in any parent folder of the desired package and then the usual

                                  1

    mvn clean install



For example to install only the compatibility v4 extra you can do the

following



    mvn clean install -N

    cd extras

    mvn clean install -N

    cd compatibility-v4

    mvn clean install



Similar for only API level 12 add on use



    mvn clean install -N

    cd add-ons

    mvn clean install -N

    cd google-apis-12

    mvn clean install



The same could be done with deploy



How To Use for Deploying Onto Remote Server

-------------------------------------------



The above deployment works fine for one machine, but what if you need

to supply a whole team of developers and a cluster of build machines

with the artifacts? Then it is best to deploy to a repository manager 

like Sonatype Nexus.



As a condition you need to have a repository server used by all

those machines and the following process will deploy to this server,

which will in turn provide the artifacts to all the machines.



Edit the repo.url property in the pom.xml to point to the repository you want to publish to. The recommended practice

is to have a separate repository for the Android components and expose it via a repository group. The repository needs

to be in Maven 2 format and use a release policy (not snapshots). For repeated runs of the deployer, you need to ensure

to allow redeployment into the specific repository. By default this is not the case for release repositories! 



Then add a server with the credentials to your settings.xml.



```xml



  

    

      android.repo

      your username

      your password

    

  



```



Run the command



    mvn deploy



in the root folder of this project (same as README you are just

reading), you can also use the same profile options for the different

api level. As a result you should find the artifact in the repository

of your remote server



For more information about this stuff look at the documentation for

the maven-deploy-plugin.



Javadoc

-------



It is possible to create javadoc artifacts for the platforms

where available in the sdk. To call it use



    mvn clean install -Pall,with-javadoc



and the respective javadoc jars will be created and also installed.

This also works for deployment to a repository server



    mvn clean deploy -Pall,with-javadoc



Mailinglist - Questions

-----------------------



Please direct any questions to the community at the Maven Android

Developers mailing list at

http://groups.google.com/group/maven-android-developers

 

Known problems

-------------



- Platforms and Add on folder names changes in SDK



When updating an existing android sdk install the add-ons subfolder

can sometimes be reused and their contents be updates so you could end

up with e.g. the google maps-4r2 in a folder named

google_apis-4_r01. To work around this just uninstall the affected

add-on and reinstall it with the android sdk tool.



Similarly the platform specific folder used to be e.g. android-1.5 and

is now android-3 using the api level as the numeric identifier. If

your SDK install uses the old folder names for any platform simply

reinstall that platform with the android tool.



In a similar manner the folder for the support libraries in the the sdk

used to be compatibility and is now support



The Add ons used different folder names as well. The Maven Android SDK

Deployer' is adapted to the lastet naming

scheme. To do that yourself remove all "Google APIs by Google Inc" in

the android SDK manager and install them again.



Similar problem occurs with the extras version identifier. If the folders 

naming is 100% allright and you receive the messages about not finding 

some artifacts - remove extras and reinstall them back. That's because Google

changed the version identifier naming policy. For example for support extras 

it was 19, now it's 19.0.1



Issues

------



If you find any problems or would like to suggest a feature, please

feel free to file an issue on github at

http://github.com/mosabua/maven-android-sdk-deployer/issues



Potential todo items

--------------------



- add custom pom files for install/deploy that eg. define dependency

  from maps to android jar



- maybe some sort of reporting of errors, failures and success as well