Jitpack发布Android库带文档和源码
忽然发现自己发布的xAndroidUtil库 写代码的时候看方法注释都看不到,研究了下如何让Jitpack发布Android库带上文档和源码
步骤
1.配置项目插件
在你的项目级别的gradle,加上下面这行插件引用
classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
如下图所示
2.配置库的gradle
之后需要在你的库里的gradle配置一下下面代码,具体代码位置可以参考下图
id 'com.github.dcendents.android-maven' // 生成文档
// 指定编码
tasks.withType(JavaCompile) {
options.encoding = "UTF-8"
}
// 打包源码
task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
classifier = 'sources'
}
task javadoc(type: Javadoc) {
failOnError false
source = android.sourceSets.main.java.sourceFiles
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
classpath += configurations.compile
}
// 制作文档(Javadoc)
task javadocJar(type: Jar, dependsOn: javadoc) {
classifier = 'javadoc'
from javadoc.destinationDir
}
artifacts {
archives sourcesJar
archives javadocJar
}
之后你可以看下你的jitpack里的编译日志确认是否生成了源码和文档的jar包
注意:
如果你的库文件里有多个库,需要每个库文件都加上,比如说我的库的项目里是有有个module的,我2个都要加上,否则会导致没加配置的那个库无法编译出来的!!