本文轉自CaryaLiu's Blog。
本文最終實現的是使用腳本打 Ad-hoc 包,并發布測試,當然稍微修改一下腳本參數就可以打其他類型的 ipa 包了。另外該腳本還實現了將生成的 ipa 包上傳至蒲公英進行測試分發。
xcodebuild 簡介
使用xcodebuild和xcrun打包簽名
將打包過程腳本化
xcodebuild 簡介
xcodebuild 是蘋果提供的打包項目或者工程的命令,了解該命令最好的方式就是使用 man xcodebuild 查看其 man page. 盡管是英文,一定要老老實實的讀一遍就好了。
DESCRIPTION
xcodebuild builds one or more targets contained in an Xcode project, or builds a scheme contained in an Xcode workspace or Xcode project.
Usage
To build an Xcode project, run xcodebuild from the directory containing your project (i.e. the directory containing the name.xcodeproj package). If you have multiple projects in the this directory you will need to use -project to indicate which project should be built. By default, xcodebuild builds the first target listed in the project, with the default build configuration. The order of the targets is a property of the project and is the same for all users of the project.
To build an Xcode workspace, you must pass both the -workspace and -scheme options to define the build. The parameters of the scheme will control which targets are built and how they are built, although you may pass other options to xcodebuild to override some parameters of the scheme.
There are also several options that display info about the installed version of Xcode or about projects or workspaces in the local directory, but which do not initiate an action. These include -list, -showBuildSettings, -showsdks, -usage, and -version.
總結一下:
需要在包含 name.xcodeproj 的目錄下執行 xcodebuild 命令,且如果該目錄下有多個 projects,那么需要使用 -project 指定需要 build 的項目。
在不指定 build 的 target 的時候,默認情況下會 build project 下的第一個 target
當 build workspace 時,需要同時指定 -workspace 和 -scheme 參數,scheme 參數控制了哪些 targets 會被 build 以及以怎樣的方式 build。
有一些諸如 -list, -showBuildSettings, -showsdks 的參數可以查看項目或者工程的信息,不會對 build action 造成任何影響,放心使用。
那么,xcodebuild 究竟如何使用呢? 繼續看文檔:
NAME
xcodebuild – build Xcode projects and workspaces
SYNOPSIS
xcodebuild [-project name.xcodeproj] [[-target targetname] … | -alltargets] [-configuration configurationname] [-sdk [sdkfullpath | sdkname]] [action …] [buildsetting=value …] [-userdefault=value …]
xcodebuild [-project name.xcodeproj] -scheme schemename [[-destination destinationspecifier] …] [-destination-timeout value] [-configuration configurationname] [-sdk [sdkfullpath | sdkname]] [action …] [buildsetting=value …] [-userdefault=value …]
xcodebuild -workspace name.xcworkspace -scheme schemename [[-destination destinationspecifier] …] [-destination-timeout value] [-configuration configurationname] [-sdk [sdkfullpath | sdkname]] [action …] [buildsetting=value …] [-userdefault=value …]
xcodebuild -version [-sdk [sdkfullpath | sdkname]] [infoitem]
xcodebuild -showsdks
xcodebuild -showBuildSettings [-project name.xcodeproj | [-workspace name.xcworkspace -scheme schemename]]
xcodebuild -list [-project name.xcodeproj | -workspace name.xcworkspace]
xcodebuild -exportArchive -archivePath xcarchivepath -exportPath destinationpath -exportOptionsPlist path
xcodebuild -exportLocalizations -project name.xcodeproj -localizationPath path [[-exportLanguage language] …]
xcodebuild -importLocalizations -project name.xcodeproj -localizationPath path
挑幾個我常用的形式介紹一下,較長的使用方式以序列號代替:
xcodebuild -showsdks: 列出 Xcode 所有可用的 SDKs
xcodebuild -showBuildSettings: 上述序號6的使用方式,查看當前工程 build setting 的配置參數,Xcode 詳細的 build setting 參數參考官方文檔 Xcode Build Setting Reference, 已有的配置參數可以在終端中以 buildsetting=value 的形式進行覆蓋重新設置.
xcodebuild -list: 上述序號7的使用方式,查看 project 中的 targets 和 configurations,或者 workspace 中 schemes, 輸出如下:
1
Information about project "NavTabBar":
Targets:
NavTabBar
NavTabBarTests
NavTabBarUITests
Build Configurations:
Debug
Release
Ad-hoc
If no build configuration is specified and -scheme is not passed then "Release" is used.
Schemes:
NavTabBar
xcodebuild [-project name.xcodeproj] [[-target targetname] ... | -alltargets] build: 上述序號1的使用方式,會 build 指定 project,其中 -target 和 -configuration 參數可以使用 xcodebuild -list 獲得,-sdk 參數可由 xcodebuild -showsdks 獲得,[buildsetting=value ...] 用來覆蓋工程中已有的配置。可覆蓋的參數參考官方文檔 Xcode Build Setting Reference, action... 的可用選項如下, 打包的話當然用 build,這也是默認選項。
build
Build the target in the build root (SYMROOT). This is the default action, and is used if no action is given.
analyze
Build and analyze a target or scheme from the build root (SYMROOT). This requires specifying a scheme.
archive
Archive a scheme from the build root (SYMROOT). This requires specifying a scheme.
test
Test a scheme from the build root (SYMROOT). This requires specifying a scheme and optionally a destination.
installsrc
Copy the source of the project to the source root (SRCROOT).
install
Build the target and install it into the target’s installation directory in the distribution root (DSTROOT).
clean
Remove build products and intermediate files from the build root (SYMROOT).
xcodebuild -workspace name.xcworkspace -scheme schemename build: 上述序號3的使用方式,build 指定 workspace,當我們使用 CocoaPods 來管理第三方庫時,會生成 xcworkspace 文件,這樣就會用到這種打包方式.
使用xcodebuild和xcrun打包簽名
開始之前,可以新建一個測試工程 TestImg 來練習打包,在使用終端命令打包之前,請確認該工程也可以直接使用 Xcode 真機調試成功。
然后,打開終端,進入包含 TestImg.xcodeproj 的目錄下,運行以下命令:
xcodebuild -project TestImg.xcodeproj -target TestImg -configuration Release
如果 build 成功,會看到 ** BUILD SUCCEEDED ** 字樣,且在終端會打印出這次 build 的簽名信息,如下:
Signing Identity: “iPhone Developer: xxx(59xxxxxx)”
Provisioning Profile: “iOS Team Provisioning Profile: *"
且在該目錄下會多出一個 build 目錄,該目錄下有 Release-iphoneos 和 TestImg.build 文件,根據我們 build -configuration 配置的參數不同,Release-iphoneos 的文件名會不同。
在 Release-iphoneos 文件夾下,有我們需要的TestImg.app文件,但是要安裝到真機上,我們需要將該文件導出為ipa文件,這里使用 xcrun 命令。
xcrun -sdk iphoneos -v PackageApplication ./build/Release-iphoneos/TestImg.app -o ~/Desktop/TestImg.ipa
這里又冒出一個 PackageApplication, 我剛開始也不知道這是個什么玩意兒,萬能的google告訴我,這是 Xcode 包里自帶的工具,使用 xcrun -sdk iphoneos -v PackageApplication -help 查看幫助信息.
Usage:
PackageApplication [-s signature] application [-o output_directory] [-verbose] [-plugin plugin] || -man || -help
Options:
[-s signature]: certificate name to resign application before packaging
[-o output_directory]: specify output filename
[-plugin plugin]: specify an optional plugin
-help: brief help message
-man: full documentation
-v[erbose]: provide details during operation
如果執行成功,則會在你的桌面生成 TestImg.ipa 文件,這樣就可以發布測試了。如果你遇到以下警告信息:
Warning: –resource-rules has been deprecated in Mac OS X >= 10.10! ResourceRules.plist: cannot read resources
請參考 stackoverflow 這個回答
將打包過程腳本化
工作中,特別是所做項目進入測試階段,肯定會經常打 Ad-hoc 包給測試人員進行測試,但是我們肯定不想每次進行打包的時候都要進行一些工程的設置修改,以及一系列的 next 按鈕點擊操作,現在就讓這些操作都交給腳本化吧。
腳本化中使用如下的命令打包:
xcodebuild -project name.xcodeproj -target targetname -configuration Release -sdk iphoneos build CODE_SIGN_IDENTITY="$(CODE_SIGN_IDENTITY)" PROVISIONING_PROFILE="$(PROVISIONING_PROFILE)"
或者
xcodebuild -workspace name.xcworkspace -scheme schemename -configuration Release -sdk iphoneos build CODE_SIGN_IDENTITY="$(CODE_SIGN_IDENTITY)" PROVISIONING_PROFILE="$(PROVISIONING_PROFILE)"
然后使用 xcrun 生成 ipa 文件:
`xcrun -sdk iphoneos -v PackageApplication ./build/Release-iphoneos/$(target|scheme).app"
清除 build 過程中產生的中間文件
結合蒲公英分發平臺,將 ipa 文件上傳至蒲公英分發平臺,同時在終端會打印上傳結果以及上傳應用后該應用的 URL。蒲公英分發平臺能夠方便地將 ipa 文件盡快分發到測試人員,該平臺有開放 API,可避免人工上傳。
該腳本的使用可使用 python autobuild.py -h 查看,與 xcodebuild 的使用相似:
Usage: autobuild.py [options]
Options:
-h, --help: show this help message and exit
-w name.xcworkspace, --workspace=name.xcworkspace: Build the workspace name.xcworkspace.
-p name.xcodeproj, --project=name.xcodeproj: Build the project name.xcodeproj.
-s schemename, --scheme=schemename: Build the scheme specified by schemename. Required if building a workspace.
-t targetname, --target=targetname: Build the target specified by targetname. Required if building a project.
-o output_filename, --output=output_filename: specify output filename
在腳本頂部,有幾個全局變量,根據自己的項目情況修改。
1
2
3
4
5
6
7
CODE_SIGN_IDENTITY = "iPhone Distribution: companyname (9xxxxxxx9A)"
PROVISIONING_PROFILE = "xxxxx-xxxx-xxx-xxxx-xxxxxxxxx"
CONFIGURATION = "Release"
SDK = "iphoneos"
USER_KEY = "15d6xxxxxxxxxxxxxxxxxx"
API_KEY = "efxxxxxxxxxxxxxxxxxxxx"
其中,CODE_SIGN_IDENTITY 為開發者證書標識,可以在 Keychain Access -> Certificates -> 選中證書右鍵彈出菜單 -> Get Info -> Common Name 獲取,類似 iPhone Distribution: Company name Co. Ltd (xxxxxxxx9A), 包括括號內的內容。
PROVISIONING_PROFILE: 這個是 mobileprovision 文件的 identifier,獲取方式:
Xcode -> Preferences -> 選中申請開發者證書的 Apple ID -> 選中開發者證書 -> View Details… -> 根據 Provisioning Profiles 的名字選中打包所需的 mobileprovision 文件 -> 右鍵菜單 -> Show in Finder -> 找到該文件后,除了該文件后綴名的字符串就是 PROVISIONING_PROFILE 字段的內容。
當然也可以使用腳本獲取, 此處參考 命令行獲取mobileprovision文件的UUID:
1
2
3
4
5
6
7
8
9
10
#!/bin/bash
if [ $# -ne 1 ]
then
echo "Usage: getmobileuuid the-mobileprovision-file-path"
exit 1
fi
mobileprovision_uuid=`/usr/libexec/PlistBuddy -c "Print UUID" /dev/stdin <<< $(/usr/bin/security cms -D -i $1)`
echo "UUID is:"
echo ${mobileprovision_uuid}
USER_KEY, API_KEY: 是蒲公英開放 API 的密鑰。
將autobuild.py腳本放在你項目的根目錄下,進入根目錄,如下使用:
1
./autobuild.py -w yourname.xcworkspace -s schemename -o ~/Desktop/yourname.ipa
或者
1
./autobuild.py -p yourname.xcodeproj -t targetname -o ~/Desktop/yourname.ipa
該腳本可在 github 查看,如有任何問題,請留言回復。
github地址:https://github.com/carya/Util