iOS自动化构建(一)

前言

本案例主要目的是实现iOS的打包发布并邮件通知功能,采用Jenkins+Git+Xcode+CocoaPods,当然了还有一些不可或缺的插件; 部署的系统一般用macOS,各平台编译工具使然,毕竟若要多平台构建方便的话, Windows整个黑苹果不太合理.

环境搭建

(一) JDK安装相关

确保系统有安装JDK. 没有的话,那就只能去Oracle官网上去下了, 不过目前好像要注册账号了, 有点麻烦的样子.

此处就以以下版本为例

注意,JDK安装后,必须$ vim ~/.bash_profile把jdk路径配置一下,然后$ source ~/.bash_profile 生效; 这样就不会再重启后导致jdk指令无效了,关于bash_profile不清楚可以参考profile、bash_profile、bashrc文件的作用与区别.

配置示例:

# Setting PATH for JDK
JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home"
export JAVA_HOME
CLASS_PATH="$JAVA_HOME/lib"
PATH=".$PATH:$JAVA_HOME/bin"

额外补充:

1.在终端输入 $ /usr/libexec/java_home 可以得到JAVA_HOME的路径; 无效时,可试着先执行下$ source ~/.bash_profile

2.检查环境. 输入 echo $JAVA_HOME 得到配置的路径，说明配置完毕.无效时,可试着先执行下$ source ~/.bash_profile

3.注意是 $ java -version而不是 $ java --version

(二) Jenkins安装相关

安装的方式有多种, 比如

1.可以在 Jenkins 的官网 下载最新的 war 包。下载完成后，打开终端，进入到 war 包所在目录，执行以下命令：

$ java -jar jenkins.war --httpPort=8080

2.可以终端直接执行

$ brew install jenkins

3.还有其他的,如在Docker中下载并运行Jenkins,等等

待Jenkins启动后，在浏览器页面输入以下地址: http://localhost:8080,
这样就打开Jenkins管理页面了.

此处不管以何种方式安装jenkins, 安装完成后打开地址都会遇到一个问题, 如何进入操作主页面呢? 如http://localhost:8080显示的重设初始密码的界面, 这个时候其实只要根据页面提示的路径拿到密码重设即可.

(三) 构建配置相关

步骤细节点可能会有多处, 可以参考下面的参考文章. 此处就不再敖述, 只记录一些容易入坑点.

1.关于插件问题

这个还是根据需求下载会比较好点, iOS打包并不一定必须Xcode插件,可以用脚本代替. 拉取代码Git插件,钥匙串、证书管理插件Keychain and Provisioning Profiles Management,邮箱通知Extended E-mail Notification插件等.

2.钥匙串和证书管理插件配置补充
插件Keychain and Provisioning Profiles Management下载后重启jenkins. 可以在管理Jenkins面板找到

配置钥匙串时注意, 先找到登录钥匙串的位置. 实际上此钥匙串关联着Xcode编译项目所用的AppleId账号及密码,亦是Team、证书、描述文件编译通过的保障. 细节可参考下面参考文章的链接. 但是钥匙串路径可能会有不同, 隐藏文件下的可以用"cmd+shift+."去查看.

上传钥匙串,默认存在login.keychain中，而macOS升级到10.12后会存在login.keychain-db,
这个时候需要拷贝出来修改后缀再上传,否则无法识别.

另外补充一点,建议把钥匙串、证书、描述文件以及打包导出配置plist文件统一拷贝放到一个相对安全且又可以访问到的文件夹下

3.参考文章部分可能年代久远了, 随着Xcode版本更替,有的指令并不适用, 比如下面的打包导出指令

xcrun -sdk iphoneos PackageApplication "./Release-iphoneos/${APP_NAME}.app" -o ~/"${IPANAME}"

工具包中并无PackageApplication文件了,有的人提供方案从旧版本Xcode拷贝一个这样的文件到新Xcode里面去. 这个就不推荐去试了,很麻烦. 所以一般而言最新的iOS打包都是采用打包导出配置plist文件, 注意archivePath后跟的路径要与xcodebuild archive生成包文件路径一致

#echo "+++++++++++++++++archive+++++++++++++++++"
#xcrun -sdk iphoneos PackageApplication "./Release-iphoneos/${APP_NAME}.app" -o ~/"${IPANAME}"
xcodebuild archive -workspace "${APP_NAME}.xcworkspace" -scheme ${APP_NAME} -configuration 'Release' -archivePath "${WORKSPACE}/build/${APP_NAME}.xcarchive"

变量exportFileConfig_PATH存放的路径即为导出配置plist文件路径.

#echo "+++++++++++++++++export+++++++++++++++++"
xcodebuild -exportArchive -archivePath ${WORKSPACE}/build/${APP_NAME}.xcarchive \
-exportPath ${IPA_PATH} \
-exportOptionsPlist ${exportFileConfig_PATH} \
-allowProvisioningUpdates \
-quiet

plist配置文件其实可以由已往的手动打包后的文件夹里面拿来修改. 其中export_method项,可以根据打包类型进行相应设置。可选的值有：app-store、ad-hoc、development、enterprise

4.使用cocoapods管理的项目, clean、build前先$ pod install一下还是有必要的, 注意前面的一些编码格式配置还是加一下, 防止编码问题

#!/bin/bash -l
export LANG=en_US.UTF-8
export LANGUAGE=en_US.UTF-8
export LC_ALL=en_US.UTF-8
pod install --verbose --no-repo-update

5.特殊注意事项

(1) 当前连接的WiFi必须能到达远程代码仓库,否则代码无法更新

(2) 因使用shell脚本打包, 取版本号做ipa存放路径名, 版本更新时需要修改info.plist文件,而不是直接修改general,否则版本号获取不到,可能会导致后续无法成功打包上传

(3) 根据Xcode项目配置的签名方式不同,shell脚本需要做相应的调整.导出plist文件也要变更. 这里给出一个手动签名和自动签名比较图

构建错误日志

错误一:

2020-10-07 15:41:25.199 xcodebuild[31298:244367]  DTDeviceKit: deviceType from b84fe20c60c909c233795932857884d923e09df2 was NULL
note: Using new build system
note: Building targets in parallel
note: Using codesigning identity override: Apple Distribution: Shenzhen xxx Digital Technology Co., Ltd.
note: Planning build
note: Constructing build description
warning: The iOS deployment target 'IPHONEOS_DEPLOYMENT_TARGET' is set to 8.0, but the range of supported deployment target versions is 9.0 to 14.0.99. (in target 'MJRefresh' from project 'Pods')
... 
error: xxx has conflicting provisioning settings. xxx is automatically signed, but code signing identity Apple Distribution: xxx Digital Technology Co., Ltd. has been manually specified. Set the code signing identity value to "Apple Development" in the build settings editor, or switch to manual signing in the Signing & Capabilities editor. (in target 'xxx' from project 'xxx')
...
warning: The iOS deployment target 'IPHONEOS_DEPLOYMENT_TARGET' is set to 8.0, but the range of supported deployment target versions is 9.0 to 14.0.99. (in target 'SnapKit' from project 'Pods')

** BUILD FAILED **

根据中间段错误提示分析可知, 既已指定自动签名了, 这里再次指定配手动有冲突?

大致意思就是说, Xcode项目配置为自动签名, 而Jenkins构建的shell里面指定了证书相当于手动签名配置. 就是下面shell中执行xcodebuild -workspace部分的这句CODE_SIGN_IDENTITY="${CODE_SIGN_DISTRIBUTION}"了. 其实去掉这句就构建编译正常了, 否则就修改Xcode项目为手动签名,并提交推送到远端仓库. 另外相应的导出plist配置文件也要做调整 signingStyle: automatic / manual, 还有其他不一致的内容,可回顾前文的对照图.

错误二:

** ARCHIVE SUCCEEDED **

📚  *** export ***
2020-10-07 16:48:38.790 xcodebuild[44921:304862] [MT] IDEDistribution: -[IDEDistributionLogging _createLoggingBundleAtPath:]: Created bundle at path '/var/folders/hh/wjpls_gn7vd6pmk1_22g51h00000gp/T/xxx_2020-10-07_16-48-38.790.xcdistributionlogs'.
error: exportArchive: "xxx.app" requires a provisioning profile with the Access WiFi Information, Associated Domains, and Push Notifications features.

Error Domain=IDEProvisioningErrorDomain Code=9 ""xxx.app" requires a provisioning profile with the Access WiFi Information, Associated Domains, and Push Notifications features." UserInfo={IDEDistributionIssueSeverity=3, NSLocalizedDescription="xxx.app" requires a provisioning profile with the Access WiFi Information, Associated Domains, and Push Notifications features., NSLocalizedRecoverySuggestion=Add a profile to the "provisioningProfiles" dictionary in your Export Options property list.}

** EXPORT FAILED **

这就是为什么要修改了, 不修改因为签名方式不一致, 且部分参数都不一致的, 所以导出直接失败

6.构建shell (推荐使用automatic签名方式)

#!/bin/bash -l

# 工程名
APP_NAME="xxx"

# 证书 此处需要主要Xcode项目配置, 如果已配置了自动签名,此处可以去掉, 否则必须加上; 不然构建时编译会出错
#CODE_SIGN_DISTRIBUTION="Apple Distribution: xxx Digital Technology Co., Ltd."

# 编译模式
development_mode='Release'

# info.plist路径
project_infoplist_path="./${APP_NAME}/Info.plist"

# 取App版本号
bundleShortVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleShortVersionString" "${project_infoplist_path}")

# 取App build号
bundleVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleVersion" "${project_infoplist_path}")

# 设置ipa导出后存放路径(文件夹名)
IPANAME="${APP_NAME}_${bundleShortVersion}(build${bundleVersion})_No${BUILD_NUMBER}"
echo "🏷  *** 构建信息# App名称:${APP_NAME}/App版本号:${bundleShortVersion}/build版本号:${bundleVersion}/构建版本:${BUILD_NUMBER} ***"

# 导出ipa配置plist文件路径
exportFileConfig_PATH="/Library/Jenkins/plist/AdHocExportOptions.plist"

# 要上传的ipa文件路径, 此处路径同上要求, 必须是能访问到的且权限足够,否则出现无法写入
IPA_PATH=${WORKSPACE}/ipas/${IPANAME} #"~/Documents/Jenkins/${IPANAME}"
echo ${IPA_PATH}

# ipa全路径
IPA_FilePath="${IPA_PATH}/${APP_NAME}.ipa"

#//下面2行是没有Cocopods的用法
#echo "📌  *** clean ***"
#xcodebuild -target "${APP_NAME}"  -configuration 'Release' clean

#echo "🛠  *** build ***"
#xcodebuild -target "${APP_NAME}" -sdk iphoneos -configuration 'Release' CODE_SIGN_IDENTITY="${CODE_SIGN_DISTRIBUTION}" SYMROOT='$(PWD)'

#//下面2行是集成有Cocopods的用法
echo "📌  *** clean ***"
xcodebuild -workspace "${APP_NAME}.xcworkspace" -scheme "${APP_NAME}"  -configuration ${development_mode} clean

#echo "🛠  *** build ***"
##xcodebuild -workspace "${APP_NAME}.xcworkspace" -scheme "${APP_NAME}" -sdk iphoneos -configuration ${development_mode} CODE_SIGN_IDENTITY="${CODE_SIGN_DISTRIBUTION}" SYMROOT='$(PWD)'
#xcodebuild -workspace "${APP_NAME}.xcworkspace" -scheme "${APP_NAME}" -sdk iphoneos -configuration 'Release' SYMROOT='$(PWD)'

echo "📦  *** archive ***" # 注意 PackageApplication已废弃
#xcrun -sdk iphoneos PackageApplication "./Release-iphoneos/${APP_NAME}.app" -o ~/"${IPANAME}"
xcodebuild archive -workspace "${APP_NAME}.xcworkspace" -scheme ${APP_NAME} -configuration ${development_mode} -archivePath "${WORKSPACE}/build/${APP_NAME}.xcarchive"

#使用 security 解锁钥匙串. 是在子节点 ssh 登录上去之后，keychain 没有被解锁.导致打包失败.
#解决方案是用 security unlock-keychain 命令将证书解锁。加不加看情况吧, 这里没啥影响
#security -v unlock-keychain -p "Aa123456"

echo "📚  *** export ***"
xcodebuild -exportArchive -archivePath ${WORKSPACE}/build/${APP_NAME}.xcarchive \
-exportPath ${IPA_PATH} \
-exportOptionsPlist ${exportFileConfig_PATH} \
-allowProvisioningUpdates \
-quiet

# 检测导出
if [ -e ${IPA_FilePath} ]; then
echo "✅  *** ipa导出成功 ***"
else
echo "❌  *** ipa导出失败 ***"
exit 1
fi


echo '🚀  *** 准备发布 ***'

# 蒲公英上的User Key
uKey="6232df2fxxxedf94cee004"
# 蒲公英上的API Key
apiKey="698515e0xxxb8cb23b64ebca1e"
# 要上传的ipa文件路径
ipa_uploadpath=${IPA_FilePath}
# 打印下全路径
echo "IPA_FilePath:${ipa_uploadpath}"

# 执行上传至蒲公英的命令
echo '☕️  *** 开始发布 ***'
#curl -F "file=@${ipa_uploadpath}" -F "uKey=${uKey}" -F "_api_key=${apiKey}" http://www.pgyer.com/apiv1/app/upload
# 将 git 上最后一次提交的注释设置为蒲公英的更新说明
MSG=`git log -1 --pretty=%B`
PASSWORD=123456
curl -F "file=@${ipa_uploadpath}" -F "uKey=${uKey}" -F "_api_key=${apiKey}" -F "updateDescription=${MSG}" -F "password=${PASSWORD}" http://www.pgyer.com/apiv1/app/upload #https://qiniu-storage.pgyer.com/apiv1/app/upload


echo ''
echo '🎉🎉🎉  *** 等待邮件通知 ***'

(四) 构建后配置相关

这里一般是邮件通知配置, 相应的可能有多种方案实现. 这里列出3种可行方式

(1) 使用上传后的蒲公英邮件下发通知, 蒲公英平台上配置即可.

(2) 直接使用Jenkins自带的邮件通知, 也会有构建后操作模块提供配置

(3) 使用邮箱插件Extended E-mail Notification. 自定义更加方便

全局配置中,Jenkins Location ->Jenkins URL可配置当前ip地址, Extended E-mail Notification以及邮件通知都得配置SMTP server, 因为一个是系统提供的, 一个是插件提供的

此处注意, 暂用1.7.1版本, 若更新会没有Use SMTP Authentication可选,构建报错"ERROR: Could not send email as a part of the post-build publishers."

参考文章

手把手教你利用Jenkins持续集成iOS项目

iOS 的自动构建流程

jenkins 配置keychains和描述文件

Jenkins + Gitlab + Docker + Spring Boot 实现自动部署

Jenkins 打包遇到的问题及解决

使用 Jenkins 实现持续集成 (iOS)

Xcode 9 distribution build fails because format of exportOptions.plist has changed in new release

遗留问题

1.fastlane的快速构建

2.应用在蒲公英发布后的回调信息截取然后写到邮件上去?

赏

感谢老板打赏哦!

微信

• 本文作者： 醉疏狂
• 本文链接： https://hubin97.github.io/2020/10/07/iOS自动化构建/
• 版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！