参考文章: 搭建用于 iOS 工程的 Gitlab CI
1 背景
由于持续集成对于整个开发流程的提速十分明显, 故在生产项目中引入持续集成工具.
iOS 端主要使用 gitlab + fastlane 进行持续集成. 通过 fir 的 CLI 工具发布 ad-hoc 包用于集成测试. gitlab 负责控制 MAC 机器(runner)上的 fastlane 进行编译, 打包及 fir 发布.
其中 gitlab runner 负责将远程仓库克隆到 runner 机器上, 然后执行在 .gitlab-ci 文件中配置的指令, 而这些指令一般都是和 fastlane 相关的.
2 详细过程
2.1 Xcode 中的工程配置(必须)
Xcode 工程中, 需要进行持续集成的 target 需要将其 scheme 设置为 shared.另外最好是每个 target 都有对应的 UnitTest 和 UITest, 因为持续集成过程中可以进行自动化测试.
2.2 节点(Runner)的配置
需要在macos系统的机器上配置runner, 当有代码push到gitlab上面时, gitlab的ci功能会自动使用已经注册到gitlab的runner来对工程进行自动化测试和构建打包.
由于当前 iOS 的节点只能是 macos 机器(因为只能用Xcode Build工具编译代码), 所以下面的 runner 也只是针对 macos 的安装.
-
下载runner程序:
sudo curl --output /usr/local/bin/gitlab-runner https://gitlab-ci-multi-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-ci-multi-runner-darwin-amd64 -
为 runner 程序添加执行权限:
sudo chmod +x /usr/local/bin/gitlab-runner -
运行runner并进行配置:
gitlab-runner register Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com ) https://gitlab.com #此处填写工程路径(gitlab中的) Please enter the gitlab-ci token for this runner xxx #此处的token可以在gitlab的对应仓库的设置中查询到 Please enter the gitlab-ci description for this runner my-runner #此处是自定义的描述信息 INFO[0034] fcf5c619 Registering runner... succeeded Please enter the executor: shell, docker, docker-ssh, ssh? shell #由于使用 xcode build, 所以选择 shell. INFO[0037] Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded! -
将 runner 程序安装为一个服务并启动它:
cd ~ gitlab-runner install gitlab-runner start重启系统, runner 便运行起来了.
2.3 gitlab 仓库配置
gitlab 中本工程的仓库中需要添加一个配置文件: .gitlab-ci.yml. 配置文件详细写法请阅读官方文档.
另外需要设置好对应的 runner. 具体在项目仓库对应的设置中设置即可.(上一步已经注册过runner了, 所以可以直接看到)
2.4 节点上 fastlane 的安装和配置
fastlane 安装详见官网. 项目中可以使用 fastlane init 进行初始化, 然后再按照实际情况修改配置文件即可.
最后一句话总结: 只要 Xcode 能够打包成功, fastlane 就能够打包成功! 如果不能工作的时候, 请先在Xcode中打包一次.
附上 .gitlab-ci 配置示例文件:
stages:
- test
- archive
- upload
- releaseBuildP
- deliverP
# 为了让上个阶段生成的文件能在下一个阶段被使用, 需要存下来.
cache:
paths:
- build/
test_project:
stage: test
script:
- fastlane test
only:
- develop
- release
archive_project:
stage: archive
script:
- fastlane beta
only:
- develop
# 测试版本发布到 fir
upload_project:
stage: upload
script:
- fir publish ./build/xxxxxx.ipa -Q -T "此处为 fir 的应用 ID"
only:
- develop
release_project:
stage: releaseBuildP
script:
- fastlane releaseAll
only:
- release
# 将打包好的release 包上传到 app-store
deliver_project:
stage: deliverP
script:
# 其中的内容也可以在单独的文件中配置
- fastlane deliver -u "苹果应用商店 ID" -a "应用的 bundle id" -i "xxxxxx.ipa" --skip_screenshots true --skip_metadata true --force true
only:
- release
fastlane 配置示例文件:
- fastfile:
fastlane_version "2.28.2"
default_platform :ios
platform :ios do
before_all do
cocoapods # 让 pod 执行 install 操作
end
lane :test do
scan
end
lane :beta do
gym(scheme: "xxxxxx", export_method: "ad-hoc", export_xcargs: "-allowProvisioningUpdates")
end
lane :releaseAll do
gym(scheme: "sillychildren_inland", export_method: "app-store", export_xcargs: "-allowProvisioningUpdates")
end
另外在 Appfile 中是执行 fastlane init 后的一些信息记录, 密码是保存在钥匙链中的:
Appfile:
app_identifier "The bundle identifier of your app"
apple_id "Your Apple email address"
team_id "Developer Portal Team ID"
在 Gymfile 中可以写一些 gym 插件的相关配置:
output_directory "./build" # 输出目录是工程根目录下的build文件夹.
export_options(
thinning: ""
)