本文主要介绍 xcodebuild 常用打包命令,以及使用 python 脚本实现自动打包 ipa 上传到蒲公英测试平台,并且发送邮件通知测试人员。
xcodebuild 简介
xcodebuild 是苹果提供的打包工程的命令
1.需要在包含 name.xcodeproj 的目录下执行 xcodebuild 命令,且如果该目录下有多个 projects,那么需要使用 -project 指定需要 build 的项目。
2.在不指定 build 的 target 的时候,默认情况下会 build project 下的第一个 target。
3.当 build workspace 时,需要同时指定 -workspace 和 -scheme 参数,scheme 参数控制了哪些 targets 会被 build 以及以怎样的方式 build。
xcodebuild 常用命令:
1.xcodebuild -version 查看xcode工具的版本号和build版本号
2.xcodebuild -showsdks 显示当前系统的SDK、及其版本
3.xcodebuild -list 先 cd 到工程目录下执行此命令 显示target Schemes 等
注意:
Xcode 升级到8.3后,打包命令使用 exportArchive 替换了 PackageApplication 进行打包。这里我们需要配置一个 exportIpaOption.plist 文件,此文件里声明了我们打包时的 Profiles(预制描述文件)以及一些其他配置。
如果你不知道这个文件怎么配置,你可以先手动用 Xcode 打一个包,包里的 ExportOptions.plist 文件就是我们自动打包需要的这个文件。如下图:
非 cocoaPods 项目的编译、打包
第一步:编译
编译命令
xcodebuild archive -scheme 工程scheme名称 -archivePath 编译后archive文件路径 -configuration Release
示例:
xcodebuild archive -scheme Test -archivePath ./build/archive/Test.xcarchive -configuration Release
打开终端 cd 到你的工程根目录,然后执行编译命令。编译成功提示信息如下:
** ARCHIVE SUCCEEDED **
第二步:打包
打包命令
xcodebuild -exportArchive -archivePath 编译时archive文件路径 -exportPath ipa安装包路径 -exportOptionsPlist exportIpaOption.plist
示例:
xcodebuild -exportArchive -archivePath ./build/archive/Test.xcarchive -exportPath./build/ipa/Test.ipa -exportOptionsPlist exportIpaOption.plist
编译完成后,接着执行打包命令。打包成功提示信息如下:
** EXPORT SUCCEEDED **
到这里,使用命令就打包成功了。会在工程根目录下生成一个 build/ipa 文件夹,里面存放的就是我们需要的 ipa 安装包。
使用了 CocoaPods 项目的编译、打包
第一步:编译
编译命令
xcodebuild archive -workspace Test.xcworkspace -scheme Test -archivePath ./build/archive/Test.xcarchive -configuration Release
第二步:打包
打包命令
xcodebuild -exportArchive -archivePath ./build/archive/Test.xcarchive -exportPath./build/Test.ipa -exportOptionsPlist exportIpaOption.plist
到这里,你是不是很激动,稍作整理,接下来,我们怎么通过 python 脚本去自动化执行上面的命令。
一:python 脚本打包
你可能会说,我对 python 一点都不懂呀!没关系,如果你对自己的编程能力挺自信的话,下面的打包脚本,你都能看懂,不需要担心。下载脚本文件autobuild.py
配置打包需要的一些信息
1、配置工程
# 项目 scheme 名称(一般就是我们的工程名称)
project_scheme = "xxxx"
# 指定项目下 build 编译目录(存放在工程根目录 build 文件里)
build_path = "./build"
# 指定项目下 archive 编译目录
archive_path = build_path + "/archive/temp.xcarchive"
# 打包后ipa存储目录(存放在工程目录 build 里的 ipa 文件里)
targer_ipa_path = build_path + "/ipa"
这里我们只需要修改 project_scheme 即可,其他都可以采用默认信息。
2、配置蒲公英
# 配置蒲公英KEY
API_KEY = "xxxxxxxxxxxxxxxxxxxx"
# 配置蒲公英更新描述信息
PGYER_DESC = "xxxxxxxxxxxxxxxxxxxx"
上传蒲公英我们需要配置蒲公英给我们分配的 API Key,以及版本描述信息。API Key是必填的,版本信息可以不传或者为空,后面我们会介绍其他一些上传信息,比如是否需要安装密码等等。
获取 API Key 方式:
3、配置邮件
# 邮件信息
from_addr = "[email protected]"
password = "xxxxxxxx"
smtp_server = "smtp.163.com"
to_addr = '[email protected]'
发送邮件,我们需要配置发送邮件账号、密码、邮件 smtp服务器 以及收件人。我们还需要开启发送邮件的 SMTP服务,这里以163邮件开启为例:
二:脚本介绍
第一步:清理项目 build目录
每次打包前,我们会清理上次的build目录
def clean_project_build():
os.system("rm -r %s" % (build_path))
print "\n** CLEAN ARCHIVE FILE SUCCEEDED **\n"
第二步:编译
def build_project():
os.system('xcodebuild archive -scheme %s -archivePath %s -configuration Release' % (project_scheme,archive_path))
第三步:打包ipa
def build_ipa():
global ipa_filename
ipa_filename = time.strftime('%Y-%m-%d-%H-%M-%S',time.localtime(time.time()))
os.system ('xcodebuild -exportArchive -archivePath %s -exportPath %s/%s -exportOptionsPlist exportIpaOption.plist'%(archive_path,targer_ipa_path,ipa_filename))
第四步:上传蒲公英
def upload_Pgyer():
ipa_path = ("%s/%s/%s.ipa" % (targer_ipa_path,ipa_filename,project_scheme))
print "ipaPath:"+ipa_path
ipa_path = os.path.expanduser(ipa_path)
upload_com = "curl -F 'file=@%s' -F '_api_key=%s' -F 'buildUpdateDescription=%s' https://www.pgyer.com/apiv2/app/upload" % (ipa_path,API_KEY,PGYER_DESC)
os.system(upload_com)
print "\n** UPLOAD TO PGYER SUCCEEDED **\n"
buildUpdateDescription:(选填) 版本更新描述,请传空字符串,或不传。
这是蒲公英给我们定义的接口说明,里面有好多参数,具体参数请看参数说明
第四步:发邮件
def send_mail():
msg = MIMEText('iOS测试项目已经打包完毕,请前往 https://www.pgyer.com/xxxxx 下载测试!', 'plain', 'utf-8')
msg['From'] = _format_addr('自动打包系统 <%s>' % from_addr)
msg['To'] = _format_addr('测试人员 <%s>' % to_addr)
msg['Subject'] = Header('iOS客户端打包程序', 'utf-8').encode()
server = smtplib.SMTP(smtp_server)
server.ehlo()
server.starttls()
server.ehlo()
server.login(from_addr, password)
server.sendmail(from_addr, [to_addr], msg.as_string())
server.quit()
print "\n** SEND EMAIL SUCCEEDED **\n"
文中的脚本是以打包非 CocoaPods 项目为例,实际中我们的项目大多都是采用 CocoaPods 的,第一小节我们已经介绍了使用了 CocoaPods 项目的编译、打包的命令,只需要在脚本里替换一下 xcodebuild 编译的命令即可,相信这点难不倒你。
第五步:执行脚本
将脚本文件放到你的工程根目录,然后在终端执行:
python autobuild.py
Mac已经自带安装了python环境,所以我们不用再安装python运行环境了。
参考文章:
iOS自动打包并发布脚本
iOS 本地自动打包工具
可能遇到的问题:
xcode-select: error: tool 'xcodebuild' requires Xcode