开篇
天生的程序猿都爱偷懒,总想着机器能干的事情就不想手动。
有一定经验的iOS开发从业人员都知道漫长的、没有技术含量的、反反复复的打包过程操作是多么无聊多么无聊多么无聊地寂寞啊。
所以有了这么一个一键打包自动发布的想法,经过一番探索与实践,总寻得一条成神之路修炼。
Bash与Shell简介
Bash 是 Unix 系统和 Linux 系统的一种 Shell(命令行环境),是目前绝大多数 Linux 发行版的默认 Shell。
首先,Shell 是一个程序,提供一个与用户对话的环境。这个环境只有一个命令提示符,让用户从键盘输入命令,所以又称为命令行环境(command line interface,简写为 CLI)。Shell 接收到用户输入的命令,将命令送入操作系统执行,并将结果返回给用户。
其次,Shell 是一个命令解释器,解释用户输入的命令。它支持变量、条件判断、循环操作等语法,所以用户可以用 Shell 命令写出各种小程序,又称为脚本(script)。这些脚本都通过 Shell 的解释执行,而不通过编译。
最后,Shell 是一个工具箱,提供了各种小工具,供用户方便地使用操作系统的功能。
在iOS开发中,我们通常编写一些自动化的脚本文件,来提高我们的生产效率,其本质就是通过Shell脚本对一些xcodebuild,xcode-select,xcrun等指令的封装,还可以通过Shell进行第三方库的导入如Pod管理工具,自动上传dSym文件到分析平台以及生成模板代码文件。可以这么说:掌握Shell脚本编程作为iOS工程师封神必备技能。
Bash简单学习
此脚本涉及的知识点并不多,简单学习bash基本命令语法即可掌握此脚本
echo命令
read命令
条件判断
变量
字符串操作
cd rm mv open mkdir 等文件夹相关操作命令
想学习更多的命令请前往Bash学习资料
准备工作
必须是MacOS系统【非苹果电脑飘过太平洋再回来吧】
项目工程在Xcode11以上版本能够正常编译无报错
开发者相关证书已存在电脑keychain中
证书配置选择自动管理
项目工程配置确保准确无误,手动能正常打包,发布验证正常下载安装后。此时说明你的项目工程各方面配置OK,可以使用脚本打包了,否则脚本同样会显示报错信息。
脚本重点知识
命令说明以及坑点说明,特别是上传App Store的时候,老报错
xcodebuild、xcrun altool
Xcode打包和上传App Store用到命令。
xcodebuild命令比较复杂,安装Xcode就有,清理clear工程和构
建archive文件,exportArchive导出ipa文件都用到此命令。
清理工程命令xcodebuild clean -workspace ${workspace_name}.xcworkspace \ -scheme ${scheme_name} \ -configuration ${build_configuration}
构建工程命令xcodebuild archive -workspace ${workspace_name}.xcworkspace \ -scheme ${scheme_name} \ -configuration ${build_configuration} \ -archivePath ${export_archive_path}
导出IPA命令xcodebuild -exportArchive \ -archivePath ${export_archive_path} \ -exportPath ${export_ipa_path} \ -exportOptionsPlist ${export_options_plist_path} \ -allowProvisioningUpdates
Xcode11之后验证应用APP和上传都是使用xcrun altool命令
验证ipaxcrun altool --validate-app -f $export_ipa_path/$ipa_name.ipa -t ios --apiKey xxx --apiIssuer xxx --verbose
上传ipa文件 xcrun altool --upload-app -f $export_ipa_path/$ipa_name.ipa -t ios --apiKey xxx --apiIssuer xxx --verbose
坑位地方特别注意
使用xcrun altool命令之前,先做好以下这两步必要工作,否则老报错
开发者账号【持有人】登录appstoreconnect管理后台,申请秘钥。如图1所示
图1开发者秘钥信息
命令中的xxx 就是指上图红色⭕️的两个ID
将申请得到的秘钥下载下来【不要修改文件名--不要修改文件名--不要修改文件名】,放到/Users/xxx/private_keys文件夹中【xxx是你当前电脑用户; 如果没有private_keys此文件夹,就创建命名private_keys的文件夹。】。如图2所示
图2文件目录
命令后面的参数请看详细的文档说明
苹果Xcodebuild命令官方
fir-cli 上传fir用到
没有安装此命令的请先安装,安装方法很简单,在终端执行命令
sudo gem install fir-cli即可
安装好之后,发布IPA文件到fir就两行命令,是不是很简单
fir login -T xxxxx # xxxxx 是你 fir.im token fir publish ffffff # ffffffffff 是你上传的ipa包路径
蒲公英平台上传
发布到蒲公英平台就简单多了,据官方文档提供的一行命令即可。 请根据开发者自己的账号,将其中的 uKey 和 _api_key 的值替换为相应的值。
curl-F"[email protected]"-F"uKey=xxx"-F"_api_key=xxx"https://www.pgyer.com/apiv2/app/upload
完整脚本
附上完整的脚本代码,请详细看注释的内容
YHAutoPackageScript.sh如下
#!/bin/sh# 使用方法:# step1: 将该脚本放在工程的根目录下(跟.xcworkspace文件or .xcodeproj文件同目录)# step2: 根据情况修改下面的参数# step3: 打开终端,执行脚本。(输入sh,然后将脚本文件拉到终端,会生成文件路径,然后enter就可)# =============项目自定义部分(自定义好下列参数后再执行该脚本)=================== ## 是否编译工作空间 (例:若是用Cocopods管理的.xcworkspace项目,赋值true;用Xcode默认创建的.xcodeproj,赋值false)is_workspace="true"# .xcworkspace的名字,如果is_workspace为true,则必须填。否则可不填workspace_name="XXX" #XXX 就是你.xcworkspace工程的名称# .xcodeproj的名字,如果is_workspace为false,则必须填。否则可不填project_name="XXX" #XXX 就是你.xcodeproj工程的名称# 指定项目的scheme名称(也就是工程的target名称),必填#scheme_name="xxx" #xxx 就是你工程里面某个target的scheme名称 echo "-------------------------输入target的scheme名称-----------------------------"echo "\033[36;1m请输入您的项目target的scheme名称(大小写区分,务必和工程中的配置一致,按回车即可) \033[0m"# 读取用户输入并存到变量里read targetNamesleep 0.5scheme_name="$targetName"echo "\033[33;1m您的项目target的scheme名称为=${scheme_name} "# 指定要打包编译的方式 : Release,Debug。一般用Release。必填build_configuration="Release"# method,打包的方式。方式分别为 development, ad-hoc, app-store, enterprise 。必填#method="ad-hoc"echo "-------------------------选择打包方式-----------------------------"echo "\033[36;1m请选择打包方式(输入序号,按回车即可) \033[0m"echo "\033[33;1m1. AdHoc \033[0m"echo "\033[33;1m2. AppStore \033[0m"echo "\033[33;1m3. Enterprise \033[0m"echo "\033[33;1m4. Development \033[0m"# 读取用户输入并存到变量里read parametersleep 0.5packMethod="$parameter"# 判读用户是否有输入if [ -n "$packMethod" ]then if [ "$packMethod" = "1" ] ; then method="ad-hoc" elif [ "$packMethod" = "2" ] ; then method="app-store" elif [ "$packMethod" = "3" ] ; then method="enterprise" elif [ "$packMethod" = "4" ] ; then method="development" else echo "输入的参数无效!!!" exit 1 fifiecho "\033[33;1m打包方式method=${method} "# 下面两个参数只是在手动指定Pofile文件的时候用到,如果使用Xcode自动管理Profile,直接留空就好# (跟method对应的)mobileprovision文件名,需要先双击安装.mobileprovision文件.手动管理Profile时必填mobileprovision_name=""# 项目的bundleID,手动管理Profile时必填bundle_identifier=""echo "--------------------脚本配置参数检查--------------------"echo "\033[33;1mis_workspace=${is_workspace} "echo "workspace_name=${workspace_name}"echo "project_name=${project_name}"echo "scheme_name=${scheme_name}"echo "build_configuration=${build_configuration}"echo "bundle_identifier=${bundle_identifier}"echo "method=${method}"echo "mobileprovision_name=${mobileprovision_name} \033[0m"echo "-------------------------选择发布平台-----------------------------"echo "\033[36;1m请选择发布平台(输入序号,按回车即可) \033[0m"echo "\033[33;1m1. AppStore \033[0m"echo "\033[33;1m2. 蒲公英pgyer \033[0m"echo "\033[33;1m3. fir平台 \033[0m"echo "\033[33;1m4. 不发布 \033[0m"# 读取用户输入并存到变量里read uploadTypeParametersleep 0.5uploadType="$uploadTypeParameter"# 是否上传分发平台(fir)is_uploadfir="true"# firTokenfir_token="xxxxxx" # xxxxxx 就是你fir平台上tokenupload_token=$fir_token# 蒲公英上传# 执行 curl -F "[email protected]" -F "uKey=xxx" -F "_api_key=xxx" https://www.pgyer.com/apiv2/app/upload 请根据开发者自己的账号,将其中的 uKey 和 _api_key 的值替换为相应的值。# =======================脚本的一些固定参数定义(无特殊情况不用修改)====================== ## 获取当前脚本所在目录script_dir="$( cd "$( dirname "$0" )" && pwd )"# 工程根目录project_dir=$script_dir# 时间DATE=`date '+%Y%m%d_%H%M%S'`# 指定输出导出文件夹路径export_path="$project_dir/Package/$scheme_name-$DATE"# 指定输出归档文件路径export_archive_path="$export_path/$scheme_name.xcarchive"# 指定输出ipa文件夹路径export_ipa_path="$export_path"# 指定输出ipa名称ipa_name="${scheme_name}_${DATE}"# 指定导出ipa包需要用到的plist配置文件的路径export_options_plist_path="$project_dir/ExportOptions.plist"echo "--------------------脚本固定参数检查--------------------"echo "\033[33;1mproject_dir=${project_dir}"echo "DATE=${DATE}"echo "export_path=${export_path}"echo "export_archive_path=${export_archive_path}"echo "export_ipa_path=${export_ipa_path}"echo "export_options_plist_path=${export_options_plist_path}"echo "ipa_name=${ipa_name} \033[0m"# =======================自动打包部分(无特殊情况不用修改)====================== #echo "------------------------------------------------------"echo "\033[32m开始构建项目 \033[0m"# 进入项目工程目录cd ${project_dir}# 指定输出文件目录不存在则创建if [ -d "$export_path" ] ; then echo $export_pathelse mkdir -pv $export_pathfi# 判断编译的项目类型是workspace还是projectif $is_workspace ; then# 编译前清理工程xcodebuild clean -workspace ${workspace_name}.xcworkspace \ -scheme ${scheme_name} \ -configuration ${build_configuration}xcodebuild archive -workspace ${workspace_name}.xcworkspace \ -scheme ${scheme_name} \ -configuration ${build_configuration} \ -archivePath ${export_archive_path}else# 编译前清理工程xcodebuild clean -project ${project_name}.xcodeproj \ -scheme ${scheme_name} \ -configuration ${build_configuration}xcodebuild archive -project ${project_name}.xcodeproj \ -scheme ${scheme_name} \ -configuration ${build_configuration} \ -archivePath ${export_archive_path}fi# 检查是否构建成功# xcarchive 实际是一个文件夹不是一个文件所以使用 -d 判断if [ -d "$export_archive_path" ] ; then echo "\033[32;1m项目构建成功 \033[0m"else echo "\033[31;1m项目构建失败 \033[0m" exit 1fiecho "------------------------------------------------------"echo "\033[32m开始导出ipa文件 \033[0m"# 先删除export_options_plist文件if [ -f "$export_options_plist_path" ] ; then #echo "${export_options_plist_path}文件存在,进行删除" rm -f $export_options_plist_pathfi# 根据参数生成export_options_plist文件/usr/libexec/PlistBuddy -c "Add :method String ${method}" $export_options_plist_path#/usr/libexec/PlistBuddy -c "Add :provisioningProfiles:" $export_options_plist_path#/usr/libexec/PlistBuddy -c "Add :provisioningProfiles:${bundle_identifier} String ${mobileprovision_name}" $export_options_plist_path/usr/libexec/PlistBuddy -c "Add :signingStyle String automatic" $export_options_plist_path/usr/libexec/PlistBuddy -c "Add :destination String export" $export_options_plist_path/usr/libexec/PlistBuddy -c "Add :compileBitcode bool false" $export_options_plist_path #如果您的工程是开启Bitcode的话,请把false改为trueecho "\033[31;1mexport_options_plist文件: ${export_options_plist_path} \033[0m"xcodebuild -exportArchive \ -archivePath ${export_archive_path} \ -exportPath ${export_ipa_path} \ -exportOptionsPlist ${export_options_plist_path} \ -allowProvisioningUpdates# 检查ipa文件是否存在if [ -f "$export_ipa_path/$scheme_name.ipa" ] ; then echo "\033[32;1mexportArchive ipa包成功,准备进行重命名\033[0m"else echo "\033[31;1mexportArchive ipa包失败 \033[0m" exit 1fi# 修改ipa文件名称mv $export_ipa_path/$scheme_name.ipa $export_ipa_path/$ipa_name.ipa# 检查文件是否存在if [ -f "$export_ipa_path/$ipa_name.ipa" ] ; then echo "\033[32;1m导出 ${ipa_name}.ipa 包成功 \033[0m" open $export_pathelse echo "\033[31;1m导出 ${ipa_name}.ipa 包失败 \033[0m" exit 1fi# 删除export_options_plist文件(中间文件)if [ -f "$export_options_plist_path" ] ; then #echo "${export_options_plist_path}文件存在,准备删除" rm -f $export_options_plist_pathfi# 输出打包总用时echo "\033[36;1m使用AutoPackageScript打包总用时: ${SECONDS}s \033[0m"if [ "$uploadType" = "1" ] ; then echo "App Store发布!!!" xcrun altool --validate-app -f $export_ipa_path/$ipa_name.ipa -t ios --apiKey xxx --apiIssuer xxx --verbose xcrun altool --upload-app -f $export_ipa_path/$ipa_name.ipa -t ios --apiKey xxx --apiIssuer xxx --verbose # xxx 就是你App Store管理后台的秘钥和apiKey信息elif [ "$uploadType" = "2" ] ; then curl -F "file=@$export_ipa_path/$ipa_name.ipa" -F "uKey=xxx" -F "_api_key=xxx" https://www.pgyer.com/apiv2/app/uploadelif [ "$uploadType" = "3" ] ; then fir login -T $upload_token # fir.im token fir publish $export_ipa_path/$ipa_name.ipaelse echo "不发布!!!" exit 0fiexit 0
使用方法
把脚本代码复制保存为XXXX.sh文件,并修改里面的XXX对应你项目工程或者是换成你自己的信息
把XXXX.sh文件放在和你项目xxx.xcodeproj文件同一个文件夹下面
打开终端进入你当前工程xxx.xcodeproj所在文件夹
执行命令sh ./XXXX.sh
根据提示输入target的scheme名称、打包方式、发布平台
作者:Lewis海
链接:https://www.jianshu.com/p/4436fc383c0b
来源:
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。