对于开发者来说,总会有一些自己写的东西,包括但不限于自定义View,自定义一些框架,有时我们开发中觉得很多大牛的东西很好用,他们一般都是托管到Github上,而他们的库都是有一些仓库来进行托管,最常用的就是maven跟jcenter了,但是对于国内开发者来说,这两个仓库的下载速度真的是一言难尽,所以最近几年出现了另外一个仓库,JitPack。这个托管仓库与Github衔接真的很棒,现在很多开源库都是托管在这里了,下载速度也是很不错的,下面介绍怎么将自己的开源库托管到JitPack。
创建自己的开源库并提交到Github
这里不多解释了,相信看这篇文章的同学对Android开发很熟练了,所以自动跳过这一步了。
配置maven仓库
这里说的配置maven仓库,是指Github的仓库插件,因为你需要通过Github来发布你的开源库嘛,肯定需要他们的插件了,这里加入插件也很简单,首先在你的项目根目录下的build.gradle文件中添加:
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.3.3'
// add github maven plugin
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
这里我使用的是1.5版本的,因为我使用的gradle版本是3.3的,各个不同的版本使用的插件版本也不一样,具体见这里。
配置好插件之后呢,还要配置一些东西,在你需要发布的library中的build.gradle文件中加入以下:
apply plugin: 'com.android.library'
// add these
apply plugin: 'com.github.dcendents.android-maven'
group='com.github.××××' // ××××代表你github名字
没错,这里就是运用插件的地方了。
这样我们的配置就完成了。有的同学可能看到有的文章写了要配置仓库,像这样:
allprojects {
repositories {
jcenter()
maven { url "https://jitpack.io" } // add this
}
}
其实这步不需要的,这步一般是验证你的库已经托管成功了才会加,所以你可加可不加,在发布库时是不需要加的。
配置好了之后,我们就可以提交代码进行发布了吗?不不不,有一重要的一步必须要执行,那就是需要我们在根目录下执行
./gradlew install
如果你不执行该命令,那么在JitPack上你的库是编译不过的,我开始没执行这句命令,一直发布不上去,查看了Log才发现。
Failed to notify ProjectEvaluationListener.afterEvaluate(), but primary configuration failure takes precedence.
java.lang.IllegalStateException: buildToolsVersion is not specified.
at com.google.common.base.Preconditions.checkState(Preconditions.java:173)
at com.android.build.gradle.BasePlugin.createAndroidTasks(BasePlugin.java:558)
at com.android.build.gradle.BasePlugin.lambda$null$4(BasePlugin.java:526)
at com.android.builder.profile.ThreadRecorder.record(ThreadRecorder.java:81)
at com.android.build.gradle.BasePlugin.lambda$createTasks$5(BasePlugin.java:522)
at org.gradle.internal.event.BroadcastDispatch$ActionInvocationHandler.dispatch(BroadcastDispatch.java:93)
at org.gradle.internal.event.BroadcastDispatch$ActionInvocationHandler.dispatch(BroadcastDispatch.java:82)
at org.gradle.internal.event.AbstractBroadcastDispatch.dispatch(AbstractBroadcastDispatch.java:44)
at org.gradle.internal.event.BroadcastDispatch.dispatch(BroadcastDispatch.java:79)
at org.gradle.internal.event.BroadcastDispatch.dispatch(BroadcastDispatch.java:30)
at org.gradle.internal.dispatch.ProxyDispatchAdapter$DispatchingInvocationHandler.invoke(ProxyDispatchAdapter.java:93)
at com.sun.proxy.$Proxy15.afterEvaluate(Unknown Source)
at org.gradle.configuration.project.LifecycleProjectEvaluator.notifyAfterEvaluate(LifecycleProjectEvaluator.java:82)
at org.gradle.configuration.project.LifecycleProjectEvaluator.doConfigure(LifecycleProjectEvaluator.java:76)
at org.gradle.configuration.project.LifecycleProjectEvaluator.access$000(LifecycleProjectEvaluator.java:33)
at org.gradle.configuration.project.LifecycleProjectEvaluator$1.execute(LifecycleProjectEvaluator.java:53)
at org.gradle.configuration.project.LifecycleProjectEvaluator$1.execute(LifecycleProjectEvaluator.java:50)
at org.gradle.internal.Transformers$4.transform(Transformers.java:169)
at org.gradle.internal.progress.DefaultBuildOperationExecutor.run(DefaultBuildOperationExecutor.java:106)
at org.gradle.internal.progress.DefaultBuildOperationExecutor.run(DefaultBuildOperationExecutor.java:61)
at org.gradle.configuration.project.LifecycleProjectEvaluator.evaluate(LifecycleProjectEvaluator.java:50)
at org.gradle.api.internal.project.DefaultProject.evaluate(DefaultProject.java:628)
at org.gradle.api.internal.project.DefaultProject.evaluate(DefaultProject.java:129)
at org.gradle.api.internal.project.DefaultProjectAccessListener.evaluateProjectAndDiscoverTasks(DefaultProjectAccessListener.java:32)
at org.gradle.api.internal.project.DefaultProjectAccessListener.beforeResolvingProjectDependency(DefaultProjectAccessListener.java:28)
at org.gradle.api.internal.artifacts.dependencies.DefaultProjectDependency.beforeResolved(DefaultProjectDependency.java:107)
...
FAILURE: Build failed with an exception.
* Where:
Build file '/home/jitpack/build/percentview/build.gradle' line: 2
* What went wrong:
A problem occurred evaluating project ':percentview'.
> Failed to apply plugin [id 'com.github.dcendents.android-maven']
> Could not create plugin of type 'AndroidMavenPlugin'.
> No service of type Factory<LoggingManagerInternal> available in ProjectScopeServices.
* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.
WARNING:
Gradle 'install' task not found. Please add the 'maven' or 'android-maven' plugin.
See the documentation and examples: https://jitpack.io/docs/
具体Log如上。
执行命令后就可以直接提交代码到Github了。
发布自己的开源库
因为Github与JitPack对接很好,所以我们在Github上操作后JitPack也会同步,在提交代码后我们需要Release我们的版本,操作也很简单,
如下图:
点击上面四个选项中的releases即可,然后按照提示创建tag以及相关信息,保存。
查看使用自己的开源库
当我们Release我们的开源库之后,就可以登录JitPack来查看开源库的情况,比如查看我的开源库情况:
这是我开源库的编译情况,在Log那栏,绿色代表编译通过,红色代表编译失败,然后点击Get it会告诉你怎么使用: 图3
这段你也可以复制到你的README.md中去,修改一下,这里JitPack还告诉怎么生成快捷链接的图标,你也可以加入到你的README.md中去
图4到此,发布到自己的开源库到JitPack就结束了,如果在发布过程中遇到问题可以使劲戳这里,这里才是最专业的!
网友评论
不太理解根目录