本文主要介绍在Mac上使用Jenkins+Git+Gradle插件搭建Android持续集成打包工具。
准备工作
这个阶段主要包括各种环境的搭建,主要是指安装JDK、SDK、Jenkins、配置Jenkins等。
1、Java环境
jenkins运行环境依赖Java环境,所以安装Jenkins之前必须安装JDK和JRE。安装好之后配置环境变量。这里就不详细介绍了。
2、安装Jenkins
打开terminal,输入brew install jenkins
命令自动下载安装Jenkins服务。
安装成功之后的提示语如下:
3、配置Jenkins
-
在terminal输入命令
jenkins
来启动Jenkins服务。启动成功的界面如下:
服务启动后,打开浏览器,在地址中输入
localhost:8080
,可以看到会提示输入Jenkins管理员密码,直接把对应路径下的密码copy一下,然后输入进去即可。-
密码输入之后,出现一个等待页面,等了一会,出现一个
离线
页面:
Google一下,发现是Jenkins没有办法正常联网,可以通过下面的办法解决:
打开一个新Tab,输入网址http://localhost:8080/pluginManager/advanced
,进入代理设置页面,页面最底下有个升级站点,把链接中的https改为http
。然后重启服务即可。
-
重启服务后,就进入到自定义Jenkins页面,该页面是选择安装插件。如果对Jenkins不熟悉,直接安装推荐的插件(多数情况下可以满足使用需求)。
-
安装好插件,进入创建管理员界面,创建一个管理员用户
-
实例配置,暂使用默认值:
-
配置完成,可以开始使用Jenkins了
进入登录页、首页
4、配置JDK、SDK、Gradle
-
进入
系统管理->系统设置
页面,找到全局属性
模块,添加一个环境变量ANDROID_HOME
:
-
进入
系统管理->全局工具配置
页面,新增JDK和Gradle工具,如图:
配置Gradle工具时注意勾选自动安装
选项。
搭建Android持续集成打包工程
1、新建任务
Jenkins构建都是以任务(job)为单位,所以需要新建一个任务。
如图有几种构建类型可以选择,最常用的是第一种,也是本文我要介绍的Demo使用的类型。(我们实际项目中使用的是流水线pipeline构建方式)。
2、配置任务
任务创建好之后,进入任务界面,如图:
点击配置按钮,进入配置页面:
如图可知,配置分为General、源码管理、构建触发器、构建环境、构建、构建后操作几个部分。下面我们简单介绍这几个模块(Jenkins功能强大,可选配置很多,本文不可能完全介绍,而且本人也没有用到那么多配置,只能把本Demo用到的配置介绍一下,其他的需要各位在实际用的过程中去研究)。
-
General
是通用配置,可以添加项目描述。
参数化构建过程
选项可能会比较常用,里面可以配置一些参数,并且定义好参数的可取值和默认值,每次构建的时候可以选择对应的值传入构建脚本中,实现不同的构建内容。举个例子:应用有三种buildType:Debug、Preview、Release,就可以在此处配置一个BUILD_TYPE,提供这三个可选值,选择之后,可以传入到脚本中使用assemble${BUILD_TYPE}
。
如果不使用自定义的工作空间
,jenkins的默认工作空间是/Users/user_zf/.jenkins/workspace/Marble_Freestyle
。
-
源码管理
必须得有项目的源码,才能构建项目。多数情况下,源码是存放在Git服务器上。此处需要配置三个信息:仓库地址、凭证、构建分支。
仓库地址很简单,就是存放项目源码的Git仓库。
构建分支也很简单,就是用来构建打包的Git分支。
凭证是指对该Git仓库的访问权限,可以在Jenkins中配置:
常用的凭证有两种:Username with password
和SSH Username with private key
。
如果Repository Url以https
开头,则使用第一种凭证。如果是以ssh
开头,则使用第二种凭证。第一种凭证很简单,直接配置自己Git服务器的用户名和密码即可。第二种复杂一些,如图:
除了Git用户名之外,还需要填写一个Private Key
,这是什么东西呢?
不用着急,慢慢看!!
如果是用ssh方式访问Git仓库,需要让Git服务器认识你的电脑才行,否则不能成功访问。所以需要在安装Jenkins的电脑上用命令生成一个秘钥对,把公钥添加到Git服务器,私钥配置在jenkins服务上,这样就可以正常访问Git仓库了。
生成秘钥对的命令如下:
cd .ssh //在用户目录下输入该命令,进入存放秘钥的目录
rm id_rsa //删除私钥(可能原来已经存在)
rm id_rsa.pub //删除公钥(可能原来已经存在)
ssh-keygen -t rsa -C "git用户名" //一路回车 生成新用户的公钥和私钥
cat id_rsa/id_rsa.pub //查看公钥和私钥的内容
生成秘钥对之后,可以查看一下:
在Git服务器上添加公钥,让Git服务器认识该电脑,我们使用的Git服务是GitLab,进入GitLab的Profile Settings->SSH Keys
界面Add SSH Key
:
把id_rsa.pub
的内容全部拷贝到Key输入框中保存。
在Jenkins上配置凭证,然后把id_rsa
中的内容全部拷贝到上面提到的Private Key
输入框中,生成一个凭证。
在Git的凭证处选择该凭证,就可以在构建时成功访问Git仓库,并且拉取代码到Job的工作空间中。
Repository Url、凭证、分支填写完毕之后,最好勾选一下Shallow clone
,拉取代码过程中不会拉取该分支历史版本的代码。否则项目过大,历史版本很多,需要拉取很长时间,一旦超过10分钟,就直接报Timeout异常。当然,也可以包超时时间设置长一点来解决超时异常。
-
构建触发器
,从字面上很好理解,就是什么时候出发构建任务。此处有一些选项,我们用到的是定时构建
可以点击问号查看语法。例如 H 7-15/5 * * 0-6
,表示周一到周六每天早上07:xx、中午12:xx打一个包 。5个参数分别表示:
- 分钟 0-59
- 小时 0-23
- DOM day of month 1-31
- MONTH 1-12
- DOW day of week 0-7
如果什么都不选,可以任务主界面手动触发构建任务。
-
构建环境
可以不用配置 -
构建
,表示构建过程。可以自定义构建步骤,如图:
通过不同插件,可以执行不同的命令。Android的打包任务相信大家都不陌生,即assembleDebu / assembleRelease
。
-
构建后操作
,构建打包完成之后,可以做很多有用的操作,比如归档Apk文件、邮件/钉钉通知相关人员、打多渠道包......
3、执行任务
上面介绍过,可以通过条件触发构建任务,也可以手动触发。在job主页,点击立即构建
即可构建任务。
构建成功之后就可以在app的build目录下找到对应的Apk文件。
至此,整个搭建过程介绍完毕了,本文演示的Demo是最基本的构建流程,在实际的项目持续集成中,往往比这个复杂,但了解基本的操作流程之后,就可以自行研究Jenkins中更加好用的功能。