打造一个高逼格的android开源项目——小白攻略

小引子

在平时的开发过程中，我们经常会查阅很多的资料，最常参考的是 github 的开源项目。通常在项目的主页面能看到项目的简介和基本使用，并且时不时能看到页面汇中有好多的彩色标签，看起来很酷，很专业，很有逼格，能提升很多的好感度。

前言

本文又是一篇很长的文章，如之前写的某篇文章一样，基本是一口气连续两三天的写。写啊写啊写，不知不觉就写了好多，其实有很多是素材图片，务必做到每个细节我都实践一遍。

考虑到同学们的时间有限，各取所需，所以按照我的惯例，首先有一篇完整版，其次，有一篇缩略版。可是这次缩略版不好做，所以综合考虑，把每个单独的知识点拆分出来，抓住重点，尽量让大家看的开心。

这里需要提醒的是：

看了完整版就不用看精简集合了，内容都一样。完整版具有一定的连贯性。
精简版就看的清爽哈，以备自己玩的时候，快速查找相关资料和步骤。

这里优先汇总下：

相关链接：

完整版：
打造一个高逼格的android开源项目——小白全攻略

精简集合版：
徽章系列1： Top 30 android 开源项目徽章
徽章系列2：JitPack 的使用
徽章系列3： Travis CI 的使用
徽章系列4： Circle CI 的使用
徽章系列5： Codecov 的使用
徽章系列6： Api_Level 的使用
徽章系列7： codacy 的使用
徽章系列8：生成个性徽章

总分类：
徽章（shields ）系列文章总分类

github 地址：
徽章项目 Demo github 地址：
https://github.com/gdky005/AndroidBadge

下面正文，正式开始。

范例

我们以最流行的 android 开源项目 MPAndroidChart 为例来看看。

1. Retrofit 0
2. okhttp 0
3. Butter Knife 0
4. MPAndroidChart 4
5. glide 1
6. picasso 0
7. zxing 3
8. lottie-android 0
9. RxAndroid 3
10. SlidingMenu 0
11. PhotoView 1
12. material-dialogs 5
13. Material-Animations 1
14. ViewPagerIndicator 0
15. plaid 0
16. PocketHub 1
17. Android-CleanArchitecture 2
18. Android-PullToRefresh 0
19. MaterialDesignLibrary 1
    （PS: 上图中的图标顺序对应下面的顺序）
    1. jitpack 徽章：JitPack 是一个仓库，类似 maven，binary, 主要是帮我们生产 android 项目的 aar or jar 的平台。基于 GitHub，可以很方便将 library 发布到远程，然后可以用 gradle 依赖到任何一个项目中。
    2. travis-ci 徽章：Travis-CI 是一个线托管的CI服务，不需要自己搭服务器，在网页上点几下就好，用起来更方便。最重要的是，它对开源项目是免费的。
    3. circle-ci 徽章：Cricle-CI 是也一个线托管的CI服务，和上面相同，不过这个相对来说比较好用一些，可以 SSH 到测试容器，方便在出问题的时候上去调试找原因，界面相对好看一些。
    4. codecov 徽章：Codecov 是开源的测试结果展示平台，将测试结果可视化。Github上许多开源项目都使用了Codecov来展示单测结果。
    5. api level 徽章：Api-Leavel 是 android-arsenal 网站提供的 android api 展示的徽章。可以在项目主页中直接使用 badge 的内容。
    6. codacy 徽章：编程代码自动审查服务平台。帮助开发者及时发现代码中的 bug，提升软件运行质量，主要包括代码质量、语法规范、功能可用性方面的检查。
    7. 个人专属 徽章：shiedls 根据自己的需求可以定制很多样式的徽章，全凭个人 爱好，怎么开心怎么玩。

    环境说明

    这里我用一个简单的 android 项目来做一个说明，其他语言也是可以的，这里仅仅展示一个实例。

    我的本机的android环境说明如下：
    – Mac
    – Android Studio 2.4 preview 4
    – gradle: 3.4.1
    – java: 1.8.0_73
    – buildToolsVersion: 25.0.2
    – compileSdkVersion: 25
    – minSdkVersion: 14
    – support: appcompat-v7:25.1.0
    – constraint: constraint-layout:1.0.0-beta4
    – classpath: com.android.tools.build:gradle:2.4.0-alpha4

    用其他版本或者环境也是可以的, 这里只是说明。 如果任何遇到问题，可以在我的博客里面留言，联系详情为：http://www.gdky005.com/about/ 因为该文的完整版真的很长，涉及到很多的技术，所以专门设立了 QQ群：621094999， 有疑问或非常感兴趣的同学，可以来次探讨，也许一些新功能就是你们发觉的呢。 （PS：本应该在文末尾添加联系方式的，但是无奈，很多网站都有爬虫系统，好不容易写的文章就被爬走了，导致很多小伙伴遇到问题后，各种留言，但是我就是看不到，所以这次采取特殊方式，见谅哈）

    JitPack 的使用

    官网： https://jitpack.io

    创建 Android Library

    1. 在 AS 中创建标准的 android 项目：
    2. 创建 badge library 成功。

    配置相关文件

    进入 jitpack android 可以看到 jitpack 为我们提供的文档帮助。

    
    2. 在 library 下的 build.gradle 中添加：
20. 点击 大绿色 按钮，并填写信息： ，拷贝当前项目地址。
21. 在 AS 的项目中创建 git 仓库： 。 项目中的文件都变成绿色后： ， 并提交到 github。

Github 打 release or tag

一般用 release 就可以了， 在适当的时候 用 tag。

在 JitPack 上生成 aar

1. 进入 https://jitpack.io/。
2. 将 github 的项目地址： https://github.com/gdky005/AndroidBadge， 直接拷贝 到 jitpack 网页中的文本框中。 ， 等里面的那个圈圈 转完 以后，出现 绿色的这个：
3. 如果是红色的，说明有错误，点开查看，修改后重新构建。

在 app Demo 中测试是否生效

点击 get 后，能看到：

给app 项目里面的 build.gradle 添加：
在项目的最底下也能看到：

问题来了，我们修改library 后也能调用到吗/h5>

让咱们一起试试吧：
1. 修改 badge 项目中的 1.0.0 为 1.0.1 ：

,
3. 然后再去 jitpack 上看看：
4. 发布成功后，我们去 app 里面试试。 。

至此， jitpack 基本也差不多了，但是貌似缺少了最重要的一点吧。

jitpack 的徽章怎么弄

还是在刚刚的 jitpack 界面，只是我们把 页面拉倒底部。

是不是看到了熟悉的 md 文档的格式呢看不懂也没关系，下面会专门讲解。
1. 拷贝内容： ，点击该文件。
3. 让我们在线编辑下：
5. 让我们 保存下。 棒棒的，添加成功。

Travis CI 的使用

官网： http://travis-ci.org/
ps: 这个是公开的，如果需要使用私有的，请使用 .com 域名。
需要提醒的是：每次提交代码后都会重新下载需要的资源文件哦，所以时间很长，耐心等待吧。

TravisCI 有什么用/h5>

travis-ci 就是 自动化 CI 工具，类似于大公司经常使用的 Jenkins，但是 travis-ci 是在云端的，而是支持 github, 还免费，我们可以 用 travis-ci 做很多的事情，不仅仅是 编译看 项目有没有问题。例如在项目构建结束以后，我们可以打包，并发布 apk 到都 蒲公英， fir，也可以用邮件通知给相关的开发人员和业务任务。 做一些简单处理，轻轻松松。这部分内容到后面尽快整理，在写一篇。

添加 github 项目到 travis-ci

1. 进入 Travis 官网后，使用 GitHub 账号 登录，成功后： ， 如果没有项目或者没有你新建的项目，请点击右上方的 Sync account 按钮。
2. 点击这里：
3. 默认是空的：
4. 直接在文件里面添加代码：

   因为该文很长很长，所以暂时就不解释具体含义了，可以看看官方文档。

   push 项目到 github, travis-ci 自动监测构建

   1. 提交到代码，并 push 到 github。会自动触发 Travis 的自动构建。 ， 黑框上的白色点点点击后会变成绿色，会自动滚动到最下面。

      回到首页刷新后，能看到：

      

      让我们来选择 markdonw 格式：

      

      加空格后，直接贴上去：

      

      添加 Travis 徽章成功。

      Bye the way! 上面是最初级的构建过程，如果遇到单元测试就不行了，还得参考 我的开源项目 TestJitpack。 不过有点乱，后面整理下。

      Circle CI 的使用

      官网: https://circleci.com/

      Circle CI 和 Travis CI 有什么区别要一起使用吗/h5>

      Circle CI 相对来说比 Travis CI 好一些，至少界面上来说哈。还提供 ssh 的连接，构建过程相对来说 比较透明直观。例如：

      ， 在 project 里面自己的账号下搜索刚创建的项目。
   2. 一般直接选择 Ubuntu 即可:
   3. 能看到：

   circle.yml 源代码：

   push 项目到 github, Circle CI 自动监测构建

   1. 提交代码后，发布到 github，Circle CI 会自动执行。
   2. ， 说明已经开始 构建了， 下载需要的东西：来源：gdky005
      

      声明：本站部分文章及图片转载于互联网，内容版权归原作者所有，如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢！