打造一个高逼格的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. picasso 0
  5. lottie-android 0
  6. SlidingMenu 0
  7. ViewPagerIndicator 0
  8. plaid 0
  9. Android-PullToRefresh 0
    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. 创建 badge library 成功。
    配置相关文件

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

Github 打 release or tag

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

在 JitPack 上生成 aar
  1. 进入 https://jitpack.io/。
  2. 如果是红色的,说明有错误,点开查看,修改后重新构建。
在 app Demo 中测试是否生效

点击 get 后,能看到:

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

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

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

jitpack 的徽章怎么弄

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

Travis CI 的使用

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

TravisCI 有什么用/h5>

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

添加 github 项目到 travis-ci

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

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

      回到首页刷新后,能看到:

      让我们来选择 markdonw 格式:

      加空格后,直接贴上去:

      添加 Travis 徽章成功。

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

      Circle CI 的使用

      官 : https://circleci.com/

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

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

    circle.yml 源代码:

    push 项目到 github, Circle CI 自动监测构建
    1. 提交代码后,发布到 github,Circle CI 会自动执行。
    2. 声明:本站部分文章及图片源自用户投稿,如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢!

上一篇 2017年5月14日
下一篇 2017年5月15日

相关推荐