{"id":1651,"date":"2015-03-20T06:42:19","date_gmt":"2015-03-20T13:42:19","guid":{"rendered":"http:\/\/wiebe-elsinga.com\/blog\/?p=1651"},"modified":"2015-03-20T13:42:38","modified_gmt":"2015-03-20T20:42:38","slug":"archive-addition-android-artifacts-with-gradle","status":"publish","type":"post","link":"http:\/\/wiebe-elsinga.com\/blog\/archive-addition-android-artifacts-with-gradle\/","title":{"rendered":"Archive addition Android artifacts with Gradle."},"content":{"rendered":"
\n<\/div>\n\n

When building Android applications or libraries common practice is to save your artifacts to a local file storage or repo.<\/p>\n

Beside your APK there are some additional artifacts you want\/need to save, and you want gradle to do this. Most common ones are Javadoc, your source files and perhaps your proguard<\/a> generated files like the mapping file.<\/p>\n

I naturally wanted a Gradle task to handle this. So lets have a look as some tasks you may want to use.
\n<\/p>\n

Adding Javadoc archive tasks<\/h3>\n

The following will add tasks to generate Javadocs for each build type and assemble it into a jar archive .<\/p>\n

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<\/div><\/td>
android.applicationVariants<\/span>.all<\/span> {<\/span> variant -><\/span>
\n    project.task<\/span>(<\/span>"${variant.name.capitalize()}Javadoc"<\/span>, type: Javadoc)<\/span> {<\/span>
\n
\n        destinationDir =<\/span> new<\/span><\/a> File<\/span><\/a>(<\/span>"$project.buildDir\/javadoc\/$variant.name"<\/span>)<\/span>
\n
\n        source =<\/span> variant.javaCompile<\/span>.source<\/span>
\n
\n        ext.androidJar<\/span> =<\/span> "${project.android.sdkDirectory}\/platforms\/${project.android.compileSdkVersion}\/android.jar"<\/span>
\n        classpath =<\/span> project.files<\/span>(<\/span>variant.javaCompile<\/span>.classpath<\/span>.files<\/span>)<\/span> +<\/span> project.files<\/span>(<\/span>ext.androidJar<\/span>)<\/span>
\n
\n        options {<\/span>
\n            linksOffline(<\/span>"http:\/\/d.android.com\/reference"<\/span>, "${project.android.sdkDirectory}\/docs\/reference"<\/span>)<\/span>
\n            links(<\/span>"http:\/\/docs.oracle.com\/javase\/7\/docs\/api\/"<\/span>)<\/span>;<\/span>
\n            setMemberLevel(<\/span>JavadocMemberLevel.PACKAGE<\/span><\/a>)<\/span>
\n            docEncoding =<\/span> 'UTF-8'<\/span>
\n            encoding =<\/span> 'UTF-8'<\/span>
\n            charSet =<\/span> 'UTF-8'<\/span>
\n        }<\/span>
\n
\n        exclude '**\/BuildConfig.java'<\/span>
\n        exclude '**\/R.java'<\/span>
\n    }<\/span>
\n
\n    project.task<\/span>(<\/span>"generate${variant.name.capitalize()}JavadocJar"<\/span>, type: Jar, dependsOn: "${variant.name.capitalize()}Javadoc"<\/span>)<\/span> {<\/span>
\n        classifier 'javadoc'<\/span>
\n
\n        description =<\/span> 'Assembles a jar archive containing the generated Javadoc API documentation of $variant.name.'<\/span>
\n
\n        destinationDir =<\/span> new<\/span><\/a> File<\/span><\/a>(<\/span>"$project.buildDir\/libs\/"<\/span>)<\/span>
\n
\n        exclude '**\/BuildConfig.class'<\/span>
\n        exclude '**\/R.class'<\/span>
\n
\n        from "$project.buildDir\/javadoc\/$variant.name"<\/span>
\n    }<\/span>
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

When added to your build.gradle<\/span><\/code> file, generate your Javadoc jar archive from the command line with gradle generateReleaseJavadocJar<\/span><\/code>.
\n<\/p>\n

Adding Source archive tasks<\/h3>\n

The following will add tasks to assemble a jar archive containing the Java sources.<\/p>\n

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<\/div><\/td>
android.applicationVariants<\/span>.all<\/span> {<\/span> variant -><\/span>
\n    project.task<\/span>(<\/span>"generate${variant.name.capitalize()}SourcesJar"<\/span>, type: Jar)<\/span> {<\/span>
\n        classifier =<\/span> 'sources'<\/span>
\n
\n        description =<\/span> 'Assembles a jar archive containing the main sources of $variant.name..'<\/span>
\n
\n        destinationDir =<\/span> new<\/span><\/a> File<\/span><\/a>(<\/span>"$project.buildDir\/libs\/"<\/span>)<\/span>
\n
\n        \/\/ exclude generated files<\/span>
\n        exclude '**\/BuildConfig.java'<\/span>
\n        exclude '**\/R.java'<\/span>
\n
\n        from variant.javaCompile<\/span>.source<\/span>
\n    }<\/span>
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

When added to your build.gradle<\/span><\/code> file, generate your Sources jar archive from the command line with gradle generateReleaseSourcesJar<\/span><\/code>.
\n<\/p>\n

Adding Proguard archive tasks<\/h3>\n

The following will add tasks to assemble a zip archive containing the generated proguard files.<\/p>\n

1
2
3
4
5
6
7
8
9
10
<\/div><\/td>
android.applicationVariants<\/span>.all<\/span> {<\/span> variant -><\/span>
\n    project.task<\/span>(<\/span>"generate${variant.name.capitalize()}ProguardFilesJar"<\/span>, type: Zip)<\/span> {<\/span>
\n        classifier 'proguard'<\/span>
\n       
\n        description =<\/span> 'Assembles a jar archive containing the Proguard files of $variant.name..'<\/span>
\n       
\n        destinationDir =<\/span> new<\/span><\/a> File<\/span><\/a>(<\/span>"$project.buildDir\/libs\/"<\/span>)<\/span>
\n        from "$project.buildDir\/outputs\/mapping"<\/span>
\n    }<\/span>    
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

When added to your build.gradle<\/span><\/code> file, generate your Proguard zip archive from the command line with gradle generateReleaseProguardFilesJar<\/span><\/code>.<\/p>\n","protected":false},"excerpt":{"rendered":"

When building Android applications or libraries common practice is to save your artifacts to a local file storage or repo. Beside your APK there are some additional artifacts you want\/need to save, and you want gradle to do this. Most common ones are Javadoc, your source files and perhaps your proguard generated files like the mapping file. I naturally wanted a Gradle task to handle this. So lets have a look as some tasks you may want to use. Adding Javadoc archive tasks The following will add tasks to generate Javadocs for each build type and assemble it into a jar archive . 123456789101112131415161718192021222324252627282930313233343536android.applicationVariants.all { variant ->     project.task("${variant.name.capitalize()}Javadoc", type: Javadoc) {         destinationDir = new File("$project.buildDir\/javadoc\/$variant.name")         source = variant.javaCompile.source         ext.androidJar = "${project.android.sdkDirectory}\/platforms\/${project.android.compileSdkVersion}\/android.jar"         classpath = project.files(variant.javaCompile.classpath.files) + project.files(ext.androidJar)         options {             linksOffline("http:\/\/d.android.com\/reference", "${project.android.sdkDirectory}\/docs\/reference")             links("http:\/\/docs.oracle.com\/javase\/7\/docs\/api\/");             setMemberLevel(JavadocMemberLevel.PACKAGE)             docEncoding = ‘UTF-8’             encoding = ‘UTF-8’             charSet = ‘UTF-8’         }         exclude ‘**\/BuildConfig.java’         exclude ‘**\/R.java’     }     project.task("generate${variant.name.capitalize()}JavadocJar", type: Jar, dependsOn: "${variant.name.capitalize()}Javadoc") {         classifier ‘javadoc’         description = ‘Assembles a jar archive containing the generated Javadoc API documentation of $variant.name.’         destinationDir = new File("$project.buildDir\/libs\/")         exclude ‘**\/BuildConfig.class’         exclude ‘**\/R.class’         from "$project.buildDir\/javadoc\/$variant.name"     } } When added to your build.gradle file, generate your Javadoc jar archive from the command line with gradle generateReleaseJavadocJar. Adding Source archive tasks The following will add tasks to assemble a jar archive containing the Java sources. 123456789101112131415android.applicationVariants.all { variant ->     project.task("generate${variant.name.capitalize()}SourcesJar", type: Jar) {         classifier = ‘sources’         description = ‘Assembles a jar archive containing the main sources of $variant.name..’         destinationDir = new File("$project.buildDir\/libs\/")         \/\/ exclude generated files         exclude ‘**\/BuildConfig.java’         exclude ‘**\/R.java’         from variant.javaCompile.source     } } When added to your build.gradle file, generate your Sources jar archive from the command line with gradle generateReleaseSourcesJar. Adding Proguard archive tasks The following will add tasks to assemble a zip archive containing the generated proguard files. 12345678910android.applicationVariants.all { variant ->     project.task("generate${variant.name.capitalize()}ProguardFilesJar", type: Zip) {         classifier ‘proguard’                 description = ‘Assembles a jar archive containing the Proguard files of $variant.name..’                 destinationDir = new File("$project.buildDir\/libs\/")         from "$project.buildDir\/outputs\/mapping"     }     } When added to your build.gradle file, generate your Proguard zip archive from the command line with gradle generateReleaseProguardFilesJar.<\/p>\n","protected":false},"author":1,"featured_media":1683,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[133,7],"tags":[154,147,148,131],"_links":{"self":[{"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/posts\/1651"}],"collection":[{"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/comments?post=1651"}],"version-history":[{"count":0,"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/posts\/1651\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/media\/1683"}],"wp:attachment":[{"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/media?parent=1651"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/categories?post=1651"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/wiebe-elsinga.com\/blog\/wp-json\/wp\/v2\/tags?post=1651"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}