您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 使用技巧 >> iOS 技巧大全

讓 Xcode 自動產生版本號:從老方法的痛點到更乾淨的 Run Script

編輯:iOS 技巧大全

在 bloglovin,我們用自動化方式設定 Xcode 的 build number,讓它等於目前 Git 分支上的 commit 數量。這套做法運作了很久,但過程並不是一帆風順。

糟糕的老方法

我們最初採用的技術來自一篇名為「Cocoa is my Girlfriend」的部落格文章。它的運作原理如下:

  1. 執行一支腳本取得 Git commit 數量,並把它輸出到一個 infoplistwhatever.h 檔案中(檔名叫什麼並不重要)。
  2. 在 Xcode 的 Target → Build Settings → Packaging 中啟用 Preprocess Info.plist File,並把 Info.plist Preprocessor Prefix File 設為上一步產生的檔案。
  3. 讓該檔案中代表 commit 數量的變數(例如 custom_build_number)成為預處理變數。
  4. 在 Info.plist 中使用 custom_build_number 取代原本的版本號欄位。

這套做法的缺點

雖然能動,但有幾個非常惱人的問題:

  1. 每次 commit 數量變動後執行 build,都會弄髒 Git 工作目錄。
  2. 若不想弄髒 Git,你必須把預處理產生的檔案加入 .gitignore。
  3. 一旦忽略了該檔案,你就得手動維護一個初始版本,否則 Xcode 第一次 build 會直接失敗(除非不提交 .gitignore,讓原始值繼續被追蹤)。
  4. 版本號不會自動更新,除非你手動 Clean 再 Build。原因是 Xcode 以一種無法被一般機制清除的方式快取了 Info.plist。我試過 build 前置方案、其他 run script 腳本等做法,都繞不過去,最後只能手動清理重建——而這恰恰抵銷了自動化的意義。

最可行的方法

經過大量搜尋,我在某篇文章的匿名留言中找到了更好的做法。它避開了上述所有缺陷,設定也更簡單:只需要在 Build Phases 的 Copy Bundle Resources 之後新增一個 Run Script 階段。

腳本內容

#
# Set the build number to the current git commit count.
# If we're using the Dev scheme, then we'll suffix the build
# number with the current branch name, to make collisions
# far less likely across feature branches.
#
# Based on:
# https://w3facility.info/question/how-do-i-force-xcode-to-rebuild-the-info-plist-file-in-my-project-every-time-i-build-the-project/
#

git=`sh /etc/profile; which git`
appBuild=`"$git" rev-list --all | wc -l`

if [ $CONFIGURATION = "Debug" ]; then
    branchName=`"$git" rev-parse --abbrev-ref HEAD`
    /usr/libexec/PlistBuddy -c "Set :CFBundleVersion $appBuild-$branchName" "${TARGET_BUILD_DIR}/${INFOPLIST_PATH}"
else
    /usr/libexec/PlistBuddy -c "Set :CFBundleVersion $appBuild" "${TARGET_BUILD_DIR}/${INFOPLIST_PATH}"
fi

echo "Updated ${TARGET_BUILD_DIR}/${INFOPLIST_PATH}"

為什麼這個方法更好

關鍵在於它用 PlistBuddy 這支命令列工具,直接修改產出目錄(${TARGET_BUILD_DIR},也就是 DerivedData 底下)裡的 Info.plist,而不是去動專案中的原始檔案。因此版本號變化時 Git 完全不會被弄髒。

更棒的是,每次 build 都會更新版本號,而不只是手動 Clean 後的第一次;並且與你目前是否停留在 Info.plist 頁面無關。這正是老方法最惱人的地方所在。

腳本中的一個小設計

這段腳本在匿名作者版本上做了些修改:它使用 Git commit 計數作為版本號,但若偵測到目前是 Debug 組態,會在版本號後加上當前分支名稱作為後綴。

這個設計解決了一個很實際的痛點:在 bloglovin,我們會同時維護六條以上的分支,版本號衝突幾乎天天發生。雖然這不是致命問題,但同版本號會讓當次 build 產生的 crash log 難以辨識歸屬。加上分支名後綴之後,這個困擾就消失了。

2014 年 9 月 14 日更新:感謝 Johan Kool 指出新腳本中的一些潛在問題,上方內容已據此修正。


範例專案:https://github.com/skyming/BuildVersion

現代做法的補充

這套 PlistBuddy 方案在當時非常優雅,但放到今日專案,通常會用 agvtool 或 Xcode 內建的 CURRENT_PROJECT_VERSION/MARKETING_VERSION 設定來處理版本號管理,並透過 xcodebuild 的參數在 CI 流程中注入 build number。

若你確實需要「依 Git commit 數自動帶入」這種行為,可以參考兩種做法:一是保留 Run Script 但改用 defaults 或 PlistBuddy 直接寫入 ${BUILT_PRODUCTS_DIR}/${INFOPLIST_PATH}(與本文精神相同);二是使用 Fastlane 的 increment_build_number 搭配 build_number 參數,讓版本管理集中在 CI 腳本中,本地 build 則維持穩定,避免每個人編譯出的號碼都不同。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved