iOS持续集成:Fastlane + 蒲公英自动打包发布

1.前言

前段时间应测试要求,需要重复测试App安装启动,为了避免重复性的工作和节省时间,所以就想到了用 Fastlane 自动化打包上传到蒲公英方便测试安装。

2.简介

Fastlane 是一套使用Ruby写的自动化工具集,用于iOS和Android的自动化打包、发布等工作,可以节省大量的时间。

3.安装

3.1 安装正确的Ruby版本,需要2.0及以上版本:

ruby -v
屏幕快照 2017-09-04 下午3.03.58.png

3.2 然后检查 Xcode 命令行工具是否安装:

xcode-select --install

报如下错误,说明已安装:

屏幕快照 2017-09-04 下午3.04.13.png

3.3 通过RubyGem安装 Fastlane 工具集:

sudo gem install fastlane

执行命令时,输入用户密码,如下图安装完成:

屏幕快照 2017-09-04 下午3.24.50.png

4.配置

4.1 打开终端,进入你的工程目录,然后执行 fastlane init:

屏幕快照 2017-09-04 下午4.00.20.png

执行过程中,需要输入对应的苹果开发账号。接下来,出现确认提示,确认无误输入y:

屏幕快照_2017-09-04_下午4_01_58.png

4.2 Fastlane 初始化完成后,工程目录下会自动生成 fastlane 文件夹,如下所示:

屏幕快照 2017-09-04 下午4.32.11.png
  • metadata: 目录:存放 App 元数据,包括 App 简介,Icon,Copyright 等;
  • screenshots: 目录:顾名思义,存放 App store 中的截图;
  • Appfile:用于指定 app_identifier, apple_id, team_id
  • Deliverfile:用于指定跟 App 版本发布相关的信息,除了 apple_identifier 外,还包括 submit_for_review, automatic_release 等可配置项,基本覆盖 iTunes Connect 里面的所有选项
  • Fastfile:用于编写逻辑脚本,使用 ruby 语言,例如首先执行 cocoapods 更新第三方依赖库,然后执行 pem 更新相关证书,接着通过 gym 来编译并打包 ipa 文件,最后通过 deliver 发布到 iTunes Connect 中,并提交审核。具体逻辑按照开发者需求自行设计。

推荐使用Sublime Text工具打开 AppfileDeliverfileFastfile 三个配置文件,首次打开是以文本格式显示的,可设置文件默认格式为Ruby。

进入 fastlane 文件,执行如下命令:

open -a /Applications/Sublime\ Text.app/ Appfile Deliverfile Fastfile
屏幕快照 2017-09-04 下午5.13.14.png

操作步骤:在Sublime Text 工作窗口,点击右下角Plain Text区域,出现的下拉菜单中选择Ruby,之后文件内容将以Ruby语法格式打开,便于编辑查看。三个文件需要分别设置默认格式。

屏幕快照 2017-09-04 下午5.08.08.png

4.3 安装蒲公英的 Fastlane 插件

在终端中,输入以下命令,即可安装蒲公英的 fastlane 插件:

fastlane add_plugin pgyer

执行过程中,出现确认提示,确认无误输入y,接下来,需要输入两次用户密码即可。

稍等几秒钟,如果出现类似下面的信息,就说明安装成功了:

屏幕快照 2017-09-04 下午5.31.16.png

5.执行

5.1 在 Fastlane 配置蒲公英插件

首先,进入工程目录,并打开 Fastlane 的配置文件(一般在 fastlane/Fastfile),这里我们用 Sublime Text打开。

然后,我们找到我们在用的工作流(action),在 gym 指令后,加入蒲公英插件的配置信息。例如:

desc "发布 测试版本 到 蒲公英"
  lane :beta_pgy do    
    gym(export_method: "ad-hoc")
    pgyer(api_key: "d066f633dc2d970eb230dba7823ff022", 
      user_key: "4477d913a078c11df32be931523619dc", 
      update_description: "fastlane自动打包上传测试 ", 
      password: "123456", 
      install_type: "2")
end
屏幕快照 2017-09-04 下午5.08.09.png

注意:
以上的 api_keyuser_key,请开发者在自己账号下的 应用管理 - App概述 - API 中可以找到,并替换到以上相应的位置。password 为安装时,需要输入的密码,install_type 为安装类型。

5.2 打包并自动上传 App 到蒲公英

bundle exec fastlane beta_pgy

执行过程中,如果出现如下错误,需要在工程目录下的Gemfile文件中添加如下信息:

gem 'cocoapods'
屏幕快照 2017-09-04 下午5.18.09.png

保存文件后,重新执行下面的命令:

bundle exec fastlane beta_pgy

稍等几十秒,最后如果出现类似下面的信息,就说明Fastlane打包上传成功了,可以进入蒲公英【我的应用】扫码下载。打包上传成功截图如下:

屏幕快照 2017-09-04 下午6.27.57.png

5.3 配置文件

有时候我们希望把账号信息、更新描述和版本号等信息单独放在一个配置文件。在这里Fastlane给我们提供了相应的解决方案。

我们可以在工程目录下创建一个名为 .env 的文件,自定义所需的临时变量,然后Fastlane的三个配置文件(AppfileDeliverfileFastfile)分别从.env文件中读取配置信息。

关于ENV用法可参考以下链接:
https://docs.fastlane.tools/advanced/#environment-variables
https://github.com/bkeepers/dotenv

.env 文件为影藏文件,可使用如下命令查看:

ls -a

截图如下:

屏幕快照 2017-09-05 下午3.54.25.png

下面给出的 .env 文件配置可做参考:
.env :

#APP唯一标识符
APP_IDENTIFIER = "xxx.xxx.TestGitProject"

#发布版本号
APP_VERSION_RELEASE = "1.1.0"

#新版本修改记录
RELEASE_NOTES = "1) 升级测试第一行\n2) 升级测试第二行"

#蒲公英 更新描述
PGY_UPDATE_DESCRIPTION = "fastlane自动打包上传测试"

#自动提交审核
SUBMIT_FOR_REVIEW = false

#审核通过后立刻发布
AUTOMATIC_RELEASE = false

#苹果开发者账号
APPLE_ID = "xxx@xxx.xxx"

#苹果开发者帐号密码
FASTLANE_PASSWORD = "xxxxxx"

#套装ID
TEAM_ID = "94xxxxx02"

#应用名称
SCHEME_NAME = "TestGitProject"

#APP元数据及截图存放路径
METADATA_PATH = "./metadata/TestGitProject"
SCREENSHOTS_PATH = "./screenshots/TestGitProject"

#APP元数据及截图下载时,直接覆盖原有数据,不询问
DELIVER_FORCE_OVERWRITE = true

AppfileDeliverfileFastfile配置文件修改如下:
Appfile

app_identifier ENV['APP_IDENTIFIER'] # The bundle identifier of your app

apple_id ENV['APPLE_ID'] # Your Apple email address

team_id ENV['TEAM_ID'] # Developer Portal Team ID

Deliverfile :

app_identifier ENV['APP_IDENTIFIER'] # The bundle identifier of your app

username ENV['APPLE_ID'] # your Apple ID user

Fastfile :

  desc "发布 测试版本 到 蒲公英"
  lane :beta_pgy do    
    gym(scheme: ENV['SCHEME_NAME'], 
      export_method: "ad-hoc",
      silent: true,  # 隐藏没有必要的信息
      clean: true  # 在构建前先clean
      )

    pgyer(api_key: ENV['PGY_API_KEY'], 
      user_key: ENV['PGY_USER_KEY'], 
      update_description: ENV['PGY_UPDATE_DESCRIPTION'], 
      password: "123456", 
      install_type: "2")
  end

配置文件截图如下:

屏幕快照 2017-09-05 下午3.43.06.png
屏幕快照 2017-09-05 下午3.43.17.png
屏幕快照 2017-09-05 下午3.42.22.png
屏幕快照_2017-09-05_下午3_43_28.png

修改完上述配置文件后,重新执行以下命令:

bundle exec fastlane beta_pgy

6.其他

Fastlane 如何实现多 Target 自动化打包发布,以及如何配置 Appfile、Deliverfile 和 Fastfile 等配置文件,发布和构建版本号自增,修改更新内容,自动上传苹果商店和自动提交审核,可参考另一篇文章:Fastlane 实现多 Target 自动化打包发布

参考链接:

  1. �Fastlane 使用中遇到的问题
  2. 使用 Fastlane 上传 App 到蒲公英

推荐阅读更多精彩内容