Gradle 使用技巧 (七) - 10 分钟将快速开源 Jitpack 与增加中文注释

本贴最后更新于 2254 天前,其中的信息可能已经斗转星移

引言

作为一个开发者,最自豪的事情就是自己的努力得到了别人的赞赏。这一次就通过一个简短的系列:如何在最简短的时间内将自己的 lib 上传到中央仓库供其他人下载,并且增加中文源码注释。

选择

前提条件:

  • 有 GitHub 帐号
  • 有需要开源的库

为了达到快速开放的目的,本次选择的仓库是 jitpack,而不选择 maven,其主要原因是 maven 太过于复杂,还需要注册账号,初次使用还可能需要花费大半天的时间。

开始

Git 仓库

查看项目结构

创建一个新的 release

new release

输入相关的值:

enter data

创建结果:

创建成功

Jitpack

打开 Jitpack,将 GitHub 仓库地址放入输入框,点击 look up

输入相关值

等待编译:

等待编译

编译成功:

编译成功

引入使用

Step 1.在根 build.gradle 添加仓库地址

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

Step 2. 添加依赖

dependencies {
	implementation 'com.github.aohanyao:GradlesKill:v0.0.1'
}

Step 3.验证引用

引用结果

增加中文注释

从上图可以看到,printTest 方法上面是没有注释的,接下来就是加入注释的操作,将以下代码块加入到 lib 的 gradle 中的 android 节点:

// 打包源码jar
task sourcesJar(type: Jar) {
	from android.sourceSets.main.java.srcDirs
	classifier = 'sources'
}
//编译groovy代码时采用 UTF-8
tasks.withType(GroovyCompile) {
	groovyOptions.encoding = "MacRoman"
}

//编译JAVA文件时采用UTF-8
tasks.withType(JavaCompile) {
	options.encoding = "UTF-8"
}

task javadoc(type: Javadoc) {
	failOnError false
	source = android.sourceSets.main.java.sourceFiles
	classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
	classpath += configurations.compile
}

// 打包文档jar
task javadocJar(type: Jar, dependsOn: javadoc) {
	classifier = 'javadoc'
	from javadoc.destinationDir
}

artifacts {
	archives sourcesJar
	archives javadocJar
}

然后重新提交代码,再创建一个 release,重复上面的步骤。

创建新的 release

创建成功

重新获取编译:

重新编译

更改依赖:

更改依赖

查看结果:

更改结果

结束

未完待续、敬请期待!

FullScreenDeveloper

源码地址

  • B3log

    B3log 是一个开源组织,名字来源于“Bulletin Board Blog”缩写,目标是将独立博客与论坛结合,形成一种新的网络社区体验,详细请看 B3log 构思。目前 B3log 已经开源了多款产品:SymSoloVditor思源笔记

    1063 引用 • 3453 回帖 • 201 关注
  • Android

    Android 是一种以 Linux 为基础的开放源码操作系统,主要使用于便携设备。2005 年由 Google 收购注资,并拉拢多家制造商组成开放手机联盟开发改良,逐渐扩展到到平板电脑及其他领域上。

    334 引用 • 323 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...