iOS打包自动化实践(一)
身为iOS开发者经常需要面对【打包】这么一个很耗时的问题,项目文件多的话每次打包时间都很久,更别提企业包还需要上传到蒲公英,AppStore包需要上传到iTunesConnect的耗时了。在维护了一年多的日版本包和release包的打包上传发布工作之后,笔者终于实现了自动化。这里把一点经验和心得整理出来。
利用fastlane和Jenkins,可以实现:
- 在远程机器(或者本地机器)上一键打包。
- Release包自动上传至iTunesConnect后台。
- 一键修改多语言发版文案。(避免了国际化的项目在iTunesConnect后台一个语言一个语音的切换,苹果的网页速度你懂的)
- 企业内测包自动上传至蒲公英,并通过Chrome的Headless功能自动截图二维码并自动通过钉钉机器人发送到工作群中。
接下来奉上详细步骤!
在本地机器上实现自动打包和上传iTunesConnect的功能。
准备工作
-
安装fastlane
sudo gem install fastlane
附一个fastlane文档地址:https://docs.fastlane.tools
-
使用xcode执行Archive, 并导出IPA,在生成的文件夹下,保存生成的ExportOptions.plist文件。
这个文件主要是保存了打包方式(debug,app-Store, adHoc), 证书名, target-描述文件对应关系,是否支持BitCode等信息,是自动打包脚本导出IPA所需要的文件。
-
工程目录下执行fastlane init, 生成fastlane文件夹和Gymfile。
脚本编写
话不多说直接脚本跑起来。这个是简化之后的伪代码脚本,需要自行修改里面相关的参数等信息。
#!/bin/sh
#设置xcode build超时时间
export FASTLANE_XCODEBUILD_SETTINGS_TIMEOUT=120
#打包并导出IPA
fastlane gym\
--workspace ${workspace_path}\
--configuration ${signingType}\
--scheme ${scheme}\
--clean true\
--include_bitcode false\
--include_symbols false\
--codesigning_identity "${codesigning_identity}"\
--output_directory ${output_path}\
--output_name "${ipa_name}"\
--build_path ${output_path}\
--export_options ${export_plist_path}
熟悉Linux脚本的同学应该很容易看懂,不懂也没有关系,只需要知道 "$"后面跟的是变量名, "\"是换行符号就可以了。 接下来详细说一下这两个命令。
第一行export,这个是为了修改环境变量,使fastlane的超时时间变成120秒。这个避免出现"xcodebuild -showBuildSettings timed out"的问题。
第二行就是打包命令fastlane gym了,这个命令就是通过我们传的参数打包,并导出IPA文件。
- --workspace 指定项目xcworkspace的绝对路径。
- --configuration 指定打包方式,取决于项目的xcode配置,默认是Debug和Release,上传AppStore的包需要使用Release配置。
- --scheme 指定scheme名称。
- --codesigning_identity 指定证书名,就是keychain里证书的名字。例如:iPhone Distribution。
- --output_directory 指定输出文件夹名, 文件夹中包括archive文件,ipa文件和dSYM文件。
- --output_name 生成的IPA名称
- --export_options 导出ipa所需的信息,用到在【准备工作】中提到的ExportOptions.plist文件,如果不想使用plist文件可以直接把信息写在这个脚本里。具体写法参见文档,这里不详细介绍了(因为plist文件是xcode自己生成的所以不会容易出错)。
运行脚本后,就会开始执行打包,在shell中可以看到脚本的详细步骤。每次打包之前fastlane都会输出Summary for gym,如果打包失败可以在shell中查看Summary for gym,检查参数是否都是正确的。
使用fastlane action命令可以方便的查看所有的参数含义,具体用法:直接在shell中敲
fastlane action gym
就可以看到gym命令的所有信息。
fastlane支持另一种方式设置参数,就是直接把所有的配置信息写在fastlane init时生成的Gymfile中。这种方式的优点是调用简单,shell脚本中只用写一行"fastlane gym"就可以实现打包功能,但是缺点是灵活性比较差,无法在shell中灵活设置每个参数(灵活性很重要,在之后集成到jenkins时会讲到),而且耦合Gymfile也不便于以后迁移至远程打包机器中。Gymfile写法
上传至AppStore
打包看起来很简单呢,只需要两行命令就可以导出IPA了,接下来在脚本里再加一行命令来实现直接上传至iTunesConnect后台。
#上传IPA到App Store Connect
fastlane deliver\
--username ${user_name}\
--app_identifier ${bundle_id}\
--app ${app_id}\
--ipa ${ipa_path}\
--skip_screenshots true\
--skip_metadata true\
--app_version ${app_version}\
--force true
参数含义:
- --username 登录iTunesConnect的帐号。
- --app_identifier 项目的Bundle Identifier。
- --app appId,登录到iTunesConnect后台复制粘贴即可,9位数字。
- --ipa 打包导出ipa文件的绝对路径
- --skip_screenshots 跳过上传屏幕截图到iTunesConnect后台的步骤。(是的fastlane可以实现这个功能,这里先实现上传ipa功能)
- --skip_metadata 跳过上传metadata到iTunesConnect后台的步骤。(metadata包括发版文案,app信息等等,之后会讲到)
- --app_version 这个版本号就是每次在iTunesConnect后台,点加号创建新版本的时候填写的版本号,fastlane会自动帮你添加版本,如果已经有了待发布版本,fastlane会自动帮你修改版本号。(必填参数,不填会报错)
与gym命令类似,deliver命令也支持把配置写在fastlane自动生成的Deliverfile中,具体写法。
好啦,到这里就可以直接运行脚本,所有的参数都没有问题的话会触发登录,然后发现shell中会要求我们填写帐号对应的密码,开启两部验证的AppleId还会要求填写6位验证码。接下来介绍如果保存密码到keychain中。
向keychain中添加iTunesConnect帐号密码:
fastlane fastlane-credentials add --username xxx@qq.com
移除旧密码:
fastlane fastlane-credentials remove --username xxx@qq.com
如果开启了两步验证
- 在appleid.apple.com/account/manage网页上生成【App 专用密码】
- 设置环境变量FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD为生成的密码,即在脚本中加入:
export FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD="****-****-****-****"
文档链接:
https://github.com/fastlane/fastlane/tree/master/credentials_manager
https://github.com/fastlane/fastlane/tree/master/spaceship#2-step-verification
FAQ
- 报错提示
xcodebuild -showBuildSettings timed out after 4 retries with a base timeout of 3.
需要在脚本中加入以下代码来设置超时时间:
export FASTLANE_XCODEBUILD_SETTINGS_TIMEOUT=120
写在最后
到这里我们已经在本地的机器上实现了打包和上传至iTunesConnect的功能,下一篇文章会介绍如何把打包项目迁移到Jenkins上并增加修改发版文案的功能。
下一篇:iOS打包自动化实践(二)