编写开源库并发布到JitPack.io

标签： Android library jitpack

---

TAG:文章中用到的库项目地址

在经历了Jcenter的各种坑后，然后最后一步：bintrayUpload到97%死活传不上去，前前后后折腾了3、4天，每天抽一小会尝试更改，结果还是没成功。

万幸找到了一个更方便的发布途径：JitPack.io。

现在记录一下我建立库并发布到JitPack.io的过程，网上教程很多，但是毕竟自己操作记录一遍还是有很大好处的。

先说一下我的开发环境和软件版本：
1. Android Studio 2.2.2
2. Java 8
3. gradle 3.2
4. SDK 23
5. 拥有一个可用的Github帐号
6. Git软件，并且配置了SSH，能够往Github上传代码

---

建立工程

第一步创建工程，一路next，最后Finish。

接着建立Module，这个就是一会我们要发布的库。

选择Android Library，然后Next。

命名库名为Library，然后Finish。

至此，我们的工程搭建完成。

编写库文件

这个是我发布的一个库， 这是项目地址。
功能类似淘宝的垂直滚动广告条，可以设置文字颜色，大小，点击事件等，效果图如下：

测试库文件

在app工程名称上右键，在弹出菜单中选择”Open Module Settings”

选择”Dependencies”选项卡，点击右侧“加号”， 弹出菜单中选择”Module Dependency”

选择:library库，点击OK.

然后编写你的app程序，测试库文件功能是否正常，如果一切正常，那么开始进行下一步。

上传Github

进入Github首页，点击右上角加号按钮，弹出的菜单中选择”New repository”。

填写项目名称，这里有个注意的地方，在最下方，初始化READ ME文件那里，最好不要勾选，这个文件你可以在本地创建好，然后上传上去，否则，在后面上传文件中，你需要多做一步”git pull”。然后点击”Create repository”按钮。

Github给出了上传代码的教程，我们需要做的是红框里的事情”push an existing repository from the command line”。

打开Git Bash，进入你的工程目录， 然后执行

git init

然后commit一次。

git add . --all

git commit -m "init"

接着按照github网站提示，提交代码。

git remote add origin git@github.com:Staray/VerticalScrollTextView.git
git push -u origin master

然后，我们给这次提交的库打一个tag，并push到github上。

git tag v1.0.0
git push origin --tags

打开Github上你的工程页面，代码已经传上来了，复制你的项目地址。

使用JitPack发布你的库

打开jitpack.io页面，并将你的项目地址复制到页面的输入框中，然后点击”Look up”按钮，等待一会。

页面就出现了刚刚我们上传好的代码，点击”Get it”。

页面自动滚动到下面使用方法页面，恭喜，你的第一个库发布成功了！

现在我们赶紧测试一下我们的库能否使用，新建一个工程，并按照JitPack提示，分别在root build.gradle添加如下代码：

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

在你的app的build gradle添加：

dependencies {
    compile 'com.github.Staray:VerticalScrollTextView:v1.0.0'
}

然后同步工程。

我的库是一个自定义控件，所以，在xml页面，我输入了自定义控件名称，Android studio 给出了提示，证明库导入成功。

使用JitPack插件发布库

网上很多教程都写了JitPack官网上的插件方式发布，可是最后都去网站上点击Look up按钮的方式发布库文件，其实如果插件安装完成，直接使用gradle就可以发布了。

按照官网提示，在root build.gradle文件中添加：

buildscript {
    dependencies {
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
        }
    }
}

在library Module 的build.gradle文件添加：

apply plugin: 'com.github.dcendents.android-maven'
group='com.github.YourUsername'

替换”YourUsername”为你的Github用户名。

完成之后，同步工程，接着Commit并push到github上，并且给当前工程添加一个新的tag，push tag到github上。

然后在Android Studio的命令行中执行如下命令：

gradlew install

执行成功之后，就表示已经成功的发布到jitpack.io上了。

测试一下，成功发布！