使用 Jenkins 持续化集成 iOS
什么是 Jenkins
Jenkins 是一款由 Java 编写的可扩展的开源的持续集成工具。它提供了软件开发的持续集成服务,其运行在 Servlet 容器中(例如:Apache Tomcat),支持软件配置管理(SCM)工具。
Jenkins 的特性
-
持续集成和持续交付
Jenkins 可以用作简单的 CI 服务器或变成任何项目的持续交付中心
-
简易安装
只要把
jenkins.war
部署到servlet
容器 -
易于配置
Jenkins 可以通过其 Web 界面轻松设置和配置,其中包括即时错误检查和内置帮助。
-
插件
凭借更新中心的数百个插件,Jenkins 与持续集成和持续交付工具链中的几乎所有工具集成。
-
可扩展
Jenkins 可以通过其插件架构进行扩展
-
分散式
Jenkins 可以轻松地在多台机器上分配工作,帮助更快地跨多个平台推动构建、测试和部署。
CI 工作流
典型的 CI 工作流是一组可自动化的步骤,在将代码变更推送到代码仓库后会自动运行。这整套流程包括自动构建、代码分析、运行测试、存档等等,甚至可通过脚本来自定义流程,以确保整个流程按照团队预定的要求来执行。
无 Jenkins 远程服务器,基于 Mac 电脑的 Jenkins 安装
一般来说,Jenkins 依赖于 Java 环境,需要前往 http://www.java.com 安装
Homebrew 安装
官网推荐在 Mac 电脑中使用 Homebrew 包管理器安装 Jenkins,Jenkins 分为两个版本 Jenkins LTS 和 * Jenkins Weekly*,安装命令如下:
Jenkins LTS 的安装
- 安装最新的版本
brew install jenkins-lts
-
启动 Jenkins 服务
brew services start jenkins-lts
-
重启 Jenkins 服务
brew services restart jenkins-lts
Jenkins Weekly 的安装
-
安装最新的版本
brew install jenkins
-
启动 Jenkins 服务
brew services start jenkins
-
重启 Jenkins 服务
brew services restart jenkins
Docker 容器安装(推荐)
参考Jenkins-docker,使用如下命令:
docker run -d -p 8080:8080 -p 50000:50000 --restart always -v jenkins_home:/var/jenkins_home jenkins/jenkins:lts-jdk11
使用 pgk 安装包安装
Download the latest package,使用安装器安装,按照流程安装即可。此安装方式会在 Mac 系统里创建一个名为 jenkins
用户,jenkins
服务就部署在这个用户下。
使用 war包 安装
Downloading Jenkins 下载 war 包,将其放在 Servlet 容器(例如:Tomcat)运行 或者 执行下面命令:
java -jar jenkins.war --httpPort=8080
war 包自带 jetty 服务器,以上命令会自动启服务器,并完成部署。此种方式安装,会在当前用户的根路径或相应的容器下创建 .jenkins
隐藏文件,并产生多余的配置文件,需手动管理,且不方便卸载。
安装后设置向导
端口号冲突的可以自行修改相应端口号,Homebrew 安装需要在目录下找到
homebrew.mxcl.jenkins-lts.plist
文件进行修改。
下载安装并运行Jenkins后,即将开始进入安装向导。当第一次访问新的Jenkins实例时,系统会要求使用自动生成的密码对其进行解锁。
-
浏览到
setup-jenkins-01-unlock-jenkins-page.jpeghttp://localhost:8080
(或安装时为Jenkins配置的任何端口),并等待 解锁 Jenkins 页面出现,按照提供的路径将密码复制并粘贴到下面输入框。
-
自定义 jenkins 插件
在 Customize Jenkins 页面内, 有两个选项:
- 安装推荐的插件 - 安装推荐的一组插件,这些插件基于最常见的用例.
-
选择插件来安装 - 选择安装的插件集。当第一次访问插件选择页面时,默认选择建议的插件。
jenkins初始化插件.png
可以选择 安装推荐的插件 ,之后可以通过 Jenkins 中的Manage Jenkins > Manage Plugins 页面在稍后的时间点安装(或删除)其他 Jenkins 插件 。
设置向导显示正在配置的Jenkins的进程以及您正在安装的所选Jenkins插件集。这个过程可能需要几分钟的时间
插件安装过程.png-
创建第一个管理员用户
Jenkins 要求创建第一个管理员用户。 出现“ 创建第一个管理员用户 ”页面时, 请在各个字段中指定管理员用户的详细信息,然后单击 保存完成 。
-
实例配置
Jenkins URL 用于给各种 Jenkins 资源提供绝对路径链接的根地址。 例如:邮件通知、PR状态更新以及提供给构建步骤的
BUILD_URL
环境变量。
有 Jenkins 远程服务器,配置 Mac 子节点
准备
- 首先,要确保安装Jenkins的远程服务器、本地Mac电脑在同一网络环境下。
- 本地 Mac 电脑需要设置允许远程登录,位于系统偏好设置->共享->远程登录,Jenkins 才能登录访问Mac电脑。
- Mac 配置提供给远程用户工作目录的读写权限
Jenkins 新增节点
- Jenkins 系统管理->管理节点-> 新建节点
- 配置节点,涉及名称、远程工作目录、启动方式(Mac 电脑 ip 地址,用户名和密钥)
- 节点属性,涉及环境变量、工具位置
节点启动
- 将新增的节点重启代理
Jenkins 配置构建部署 iOS 项目
jenkins 里最常用的功能就是 job 的构建,即任务的构建,通过配置 job 完成 iOS 项目的构建部署。根据需要选择不同的任务类型,这里以自定义 FreeStyle Item 为示例 。
环境配置
证书和描述文件
Xcode 构建依赖于证书和描述文件,如果当前电脑上有证书和描述文件需要在构建时使用 security unlock-keychain $KEYCHAIN
解锁,当电脑上没有证书和描述文件时,可以通过手动配置。
还有另外一个办法就是使用 Keychains and Provisioning Profiles Management 插件,它会将 iOS 和 OSX 项目的钥匙串和移动配置文件管理集成到 Jenkins 中。只需上传钥匙串和配置文件并配置您的构建作业以使用它们。执行构建时,钥匙串和配置文件会自动分发到 Jenkins 节点(主节点或从节点)。无需在每个 Jenkins 节点上手动管理这些文件。
- 将
~/Library/Keychains/login.keychain-db
拷贝到桌面,并将其改名为login.keychain
- 在 Upload Keychains and Provisioning Profiles Management 处选择
login.keychain
上传 - 配置 Code Signing Identity
- 上传描述文件,默认安装后的描述文件在
~/Library/MobileDevice/Provisioning Profiles
注:需使用 2.263.4 的版本才可以上传钥匙串和配置文件,无多个节点的情况可以不考虑
构建流程
一般地,使用 jenkins 是为了自动触发或者手动触发执行下面流程得到最终产物:
- 获取最新代码
- 参数化构建
- 上传服务器
- 分发
参数化构建
在构建过程中,可能会需要选择分支、标签以及不同的环境选择,可以通过勾选 参数化构建过程,配置相应的参数。
jenkins参数化构建.png这里以 Git 参数为例,配置相应变量名称,描述、参数类型和默认值:
JenkinsGit参数.png需安装git parameter 插件
源码管理
配置相应的源码仓库,分支通过变量参数获取,Jenkins 会在触发时拉取指定分支的代码
源码仓库配置.png构建触发器
-
通过调用 Jenkins REST API 触发远程构建,Jenkins REST API可以通过 http://localhost:port/job/api/ 查看
-
可以通过其它 job 构建后触发
-
通过定时构建
-
通过提交代码触发
构建
构建 可以使用 fastlane 或者 Shell 脚本,参考即可
总结
在 iOS 开发者,Jenkins 更适用于单独一个 Mac 电脑作为打包机提供给团队进行自动化构建,如果已有 Jenkins 服务器,可以将 Mac 作为其从子节点,并可以利用 Jenkins REST API 及其他技术等等搭建一个自动化构建平台,从而减少团队开发因构建、部署和分发而浪费的时间。