一、前言
这段时间一直在参与开发前端项目。与iOS工作流程不同的是,前端给QA提测前,只需将feature分支代码合到一个指定的分支。然后QA人员会通过Jenkins工具进行项目的构建部署。之前在探索iOS的自动化打包时,就听过Jenkins的大名,但是一直没去了解。这次借此机会由最擅长的iOS项目为切入点,开始对Jenkins的探索。
二、安装Jenkins
**Jenkins**依赖了Java环境,所以在安装Jenkins前,要确保系统要安装了Java
- 安装Java
终端输入命令,若不识别。说明没有安装Java JDK
java --version
若没有安装或版本过低,可通过以下链接下载。注意要根据自己电脑的系统选择对应的版本
Java JDK下载
- 安装Jenkins
brew install jenkins
这里有两个坑要提一下
- brew安装jenkins的版本不是最新版本。这会导致有些必要的Jenkins插件不能安装。
解决办法: 卸载重装HomeBrew- brew命令后总是卡在updating处
解决办法: 不要关闭当前终端窗口,新开一个窗口。并再次输入brew命令
- 开启Jenkins服务
brew services start jenkins
第一次服务开启成功后,在浏览器中输入http://localhost:8080,会出现一个让你输入Jenkins初始密码的页面
- 获取Jenkins初始密码
defaults write com.apple.finder AppleShowAllFiles YES
vi /Users/jackey/.jenkins/secrets/initialAdminPassword
将获取到的初始密码输入后,重启Jenkins
brew services restart jenkins
重新输入http://localhost:8080,会进入配置界面。点击安装建议的插件,耐心等待插件安装过程(时间较长)
若过程中有插件安装失败,可查看失败日志。我当初遇到的问题就是Jenkins版本过低,所以有些插件不能安装。原因是brew版本过低导致
- 创建管理员账户
插件安装成功后,进入如下界面
按要求将所有项目填写成功后,点击保存就可以正常使用Jenkins了 - 通过url来关闭/重启Jenkins
http://localhost:8080/restart
http://localhost:8080/exit
三、Jenkins中配置iOS项目
-
新建Item,创建一个任务。输入任务名后,选择第一项:Freestyle project
-
配置General项
-
源码管理项
-
CocoaPods/Carthage依赖配置项
选择构建->增加构建配置->Execute Shell。将拉取Pod/Carthage的命令填进去
这里有两个注意点
- 直接
pod install --verbose --no-repo-update
会报错,pod: command not found
解决方法: export 语句将控制台语言环境设置为 UTF-8 格式,避免出现 Podfile 文件打开错误。- 在构建中添加 pod install 脚本要用左边的bar托到构建项的第一位
-
Xcode-General build settings配置
-
Xcode-Code signing配置
-
Xcode-OS X keychain options配置
-
Xcode-Advanced Xcode build options配置
- 添加打包并上传蒲公英脚本
增加构建步骤-Execute Shell。输入以下脚本
# 工程名
APP_NAME="XLLJenkinsDemo"
# 证书,如果自动选择证书,设为“iPhone Developer”即可
CODE_SIGN_DEVELOPER="iPhone Developer"
# info.plist路径
project_infoplist_path="./${APP_NAME}/Info.plist"
#取版本号
bundleShortVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleShortVersionString" "${project_infoplist_path}")
#取build值
bundleVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleVersion" "${project_infoplist_path}")
DATE="$(date +%Y%m%d)"
IPANAME="${APP_NAME}_V${bundleShortVersion}_${DATE}.ipa"
#要上传的ipa文件路径
IPA_PATH="$HOME/${IPANAME}"
echo ${IPA_PATH}
#echo "${IPA_PATH}">> text.txt
#集成有Cocopods的用法
echo "=================clean================="
xcodebuild -workspace "${APP_NAME}.xcworkspace" -scheme "${APP_NAME}" -configuration 'Release' clean
echo "+++++++++++++++++build+++++++++++++++++"
xcodebuild -workspace "${APP_NAME}.xcworkspace" -scheme "${APP_NAME}" -sdk iphoneos -configuration 'Release' CODE_SIGN_IDENTITY="${CODE_SIGN_DEVELOPER}" SYMROOT='$(PWD)'
xcrun -sdk iphoneos PackageApplication "./Release-iphoneos/${APP_NAME}.app" -o ~/"${IPANAME}"
#上传到蒲公英
#蒲公英上的user Key
uKey="..."
#蒲公英上的API Key
apiKey="..."
#蒲公英版本更新描述,这里取git最后一条提交记录作为描述
MSG=`git log -1 --pretty=%B`
#要上传的ipa文件路径
echo $IPA_PATH
#执行上传至蒲公英的命令
echo "++++++++++++++upload+++++++++++++"
curl -F "file=@${IPA_PATH}" -F "uKey=${uKey}" -F "_api_key=${apiKey}" -F "buildUpdateDescription=${MSG}" http://www.pgyer.com/apiv2/app/upload
四、项目构建
-
点击Build Now,可在Build History中看到构建进度。我们可以点击进度条进入构建实时详情
-
在详情中,点击控制台输出,可以查看构建日志
-
在日志最后前几行发现Build Success,说明项目构建成功。
-
在日志最后发现如下信息,说明上传蒲公英成功
这里构建时,一开始不出意外必然会出现各种各样导致构建失败的错误。根据日志报错信息的提示对症去解决问题即可。
- 不要担心日志密密麻麻的信息,一般全局搜索error或者仅仅查看最后十几二十行的日志,就可以读到关键信息。
一般是项目配置或者签名文件和配置证书的问题
这里我只将自己遇到的一个特殊的报错总结出来
运行xcrun脚本后报错:xcrun: error: unable to find utility "PackageApplication", not a developer tool or in PATH
可以看出在执行最后的脚本配置出现报错,最后在网上找到了原因和解决办法
原因:新版的Xcode少了这个PackageApplication(转注:PackageApplication在前几个版本已被标识为废弃,在8.3版本彻底移除了)
解决办法:
- 找个旧版的Xcode里面copy到以下目录
/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin/
- 执行以下两个命令
sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer/ chmod +x > /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin/PackageApplication
附上PackageApplication下载地址:
https://pan.baidu.com/s/1jHJF2Lo
来源://www.greatytc.com/p/c83483289970
五、其他注意点
项目中如果有使用Pod、Carthage对三方库进行管理依赖,一定要确保安装了Carthage、Pod。并且执行了pod setup
,否则构建也会失败。
Jenkins的工作区路径为/Users/xxx/.jenkins/workspace/
,小伙伴们可以定期去进行清理或根据工作区内工程的情况定位问题。
目前iOS项目使用的是gitlab自身的runner进行自动化打包。后面打算将项目也使用Jenkins配置起来,这样iOS项目也可以像前端项目一样交给QA人员统一去构建处理打包。
接下来再研究一波前端Jenkins配置流程及原理,敬请期待。。。