Skip to content

Instantly share code, notes, and snippets.

@Robyer
Last active June 15, 2023 04:22
Star You must be signed in to star a gist
Save Robyer/a6578e60127418b380ca133a1291f017 to your computer and use it in GitHub Desktop.
Gradle script for publishing Android library with sources and javadoc to Maven repository using maven-publish plugin.
// You can use maven-publish-helper.gradle script without changes and even share it between multiple
// modules. Just place the maven-publish-helper.gradle file in the root directory of your project,
// then apply it at the bottom of your module's build.gradle file like this:
// ...content of module's build.gradle file...
apply from: '../maven-publish-helper.gradle'
publishing {
publications {
release(MavenPublication) {
// Specify own groupId as package name of your library,
// otherwise it would just use project's name (=name of the root directory) by default.
groupId 'com.example'
// Specify custom artifactId if needed,
// otherwise it would use module's name by default.
//artifactId 'custom-artifact'
// You can specify custom version,
// otherwise it would use version from `android { defaultConfig { ... } }` by default.
//version = '1.0'
}
}
}
/**
* Maven Publish Helper
*
* Requires Android Gradle plugin 3.6.0 or higher (available since Android Studio 3.6).
* See also: https://developer.android.com/studio/build/maven-publish-plugin
*
* @Author Robert Pösel
* @Version 1.5
* @Date 3.3.2020
*/
apply plugin: 'maven-publish'
task androidJavadocs(type: Javadoc) {
source = android.sourceSets.main.java.srcDirs
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
android.libraryVariants.all { variant ->
if (variant.name == 'release') {
owner.classpath += variant.javaCompileProvider.get().classpath
}
}
exclude '**/R.html', '**/R.*.html', '**/index.html'
}
task androidJavadocsJar(type: Jar, dependsOn: androidJavadocs) {
archiveClassifier.set('javadoc')
from androidJavadocs.destinationDir
}
task androidSourcesJar(type: Jar) {
archiveClassifier.set('sources')
from android.sourceSets.main.java.srcDirs
}
// Because the components are created only during the afterEvaluate phase, you must
// configure your publications using the afterEvaluate() lifecycle method.
afterEvaluate {
publishing {
publications {
// Creates a Maven publication called "release".
release(MavenPublication) {
// Applies the component for the release build variant.
from components.release
// Adds javadocs and sources as separate jars.
artifact androidJavadocsJar
artifact androidSourcesJar
// You can customize attributes of the publication here or in module's build.gradle file.
//groupId = 'com.example'
//artifactId = 'custom-artifact'
version = android.defaultConfig.versionName // or just '1.0'
}
}
}
}
@Robyer
Copy link
Author

Robyer commented Dec 31, 2020

@realchandan Maybe you are using some incompatible version of Gradle plugin or other library? I am using it with stable Android Studio with Java codebase. You can try to use it in new empty project.

@ivangarza6
Copy link

@Robyer I"m having trouble keeping my JNI and native lib dependencies inside my AAR. I suspect the pom file requires me to specify then? I could really use some help!

@Robyer
Copy link
Author

Robyer commented Jan 26, 2021

@ivangarza6 I think you should ask question on StackOverflow instead, I don't have experience with specifying native lib dependencies. I'm not even sure whether Android Studio / Gradle currently supports them.

@Robyer
Copy link
Author

Robyer commented Mar 29, 2021

@Petrakeas You need to first publish the moduleB with this script as one aar. Then you need to modify the moduleA's build.gradle and reference that moduleB from repository (e.g. as implementation 'com.example:moduleB:1.0.0' instead of implementation project(':moduleB')) and publish it as second aar (moduleA). This way reference to moduleB will be saved in the moduleA's *.pom file and Gradle will automatically download this dependency when downloading moduleA from the repository.

@Petrakeas
Copy link

Petrakeas commented Mar 29, 2021

@Petrakeas You need to first publish the moduleB with this script as one aar. Then you need to modify the moduleA's build.gradle and reference that moduleB from repository (e.g. as implementation 'com.example:moduleB:1.0.0' instead of implementation project(':moduleB')) and publish it as second aar (moduleA). This way reference to moduleB will be saved in the moduleA's *.pom file and Gradle will automatically download this dependency when downloading moduleA from the repository.

Thanks Robyer. I actually deleted by question (before you answered), because I noticed that when I had both modules configured for publishing with the proposed script, the maven-publish plugin worked automatically. It seems that maven-publish plugin was smart enough to replace the dependancy with one referencing maven. It even picked-up my custom artifactId that was different to the actual module name!

@Robyer
Copy link
Author

Robyer commented Mar 29, 2021

@Petrakeas I noticed that when I had both modules configured for publishing with the proposed script, the maven-publish plugin worked automatically. It seems that maven-publish plugin was smart enough to replace the dependancy with one referencing maven. It even picked-up my custom artifactId that was different to the actual module name!

Thanks for interesting info! I didn't know that and it sounds great.

@Petrakeas
Copy link

In case it helps someone, I have made some changes that enable correct UTF-8 Javadoc generation, repeatable builds and support for Java and Android Gradle plugin. I have created a guide here.

@Robyer
Copy link
Author

Robyer commented Mar 1, 2022

With Android Gradle Plugin 7.1 it is now very simple to do this without needing any complicated scripts. AGP now also handles creating source and javadocs jar.

You don't need any separate scripts, just write everything into your build.gradle file of your module:

plugins {
    ...
    id 'maven-publish'
}
android {
    ...
    publishing {
        singleVariant("release") {
            // if you don't want sources/javadoc, remove these lines
            withSourcesJar()
            withJavadocJar()
        }
    }
}
afterEvaluate {
    publishing {
        publications {
            release(MavenPublication) {
                from components.release
                groupId 'com.example'
                artifactId 'mylibrary'
                version = android.defaultConfig.versionName // or manually '1.0'
            }
        }
    }
}

See also: https://developer.android.google.cn/studio/build/maven-publish-plugin

@nikunj-unifynd
Copy link

nikunj-unifynd commented May 5, 2023

when I publish using gradle publish task i am getting the following error:
Execution failed for task ':project-name:androidJavadocs'.

path may not be null or empty string. path=''

Pls help

@Robyer
Copy link
Author

Robyer commented May 5, 2023

@nikunj-unifynd It would be better for you to ask this question on StackOverflow, providing also additional info as content of your build.gradle file, because maybe you have some conflicting configuration there.

Or just start by creating new empty Android Studio project, and add this publishing code there. Then if it works, compare how your project where it doesn't work differs and try to find the issue.

@RahulSDeshpande
Copy link

RahulSDeshpande commented Jun 15, 2023

Thanks @Robyer

Guys FYI
Official Google Documentation:
https://developer.android.com/build/publish-library

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment