iOS中使用Fastlane實現自動化打包和釋出
Fastlane是一套使用Ruby寫的自動化工具集,用於iOS和Android的自動化打包、釋出等工作,可以節省大量的時間。
Fastlane
Github:https://github.com/fastlane/fastlane
官網:https://fastlane.tools/
文件:https://docs.fastlane.tools/
在寫這篇文章的時候,他在Github上已經有15000+ star。
安裝
1、首先要安裝正確的 Ruby 版本。在終端視窗中用下列命令來確認:
ruby -v
2、然後檢查 Xcode 命令列工具是否安裝。在終端視窗中輸入命令:
xcode-select --install
如果未安裝,終端會開始安裝,如果報錯誤:command line tools are already installed, use "Software Update" to install updates.代表已經安裝。
3、以上依賴配置好之後就可以通過 rubygem 進行安裝了:
$ sudo gem install fastlane
安心等待一會,fastlane就安裝完成了。
初始化
開啟終端,cd到你的工程目錄,然後執行fastlane init:
$ cd to/your/ios/project $ fastlane init [14:21:43]: Detected iOS/Mac project in current directory... [14:21:43]: This setup will help you get up and running in no time. [14:21:43]: fastlane will check what tools you're already using and set up [14:21:43]: the tool automatically for you. Have fun! [14:21:43]: Created new folder './fastlane'. [14:21:43]: $ xcodebuild -showBuildSettings -project ./xxx.xcodeproj [14:21:48]: Your Apple ID (e.g.[email protected]): [email protected] [14:21:54]: Verifying that app is available on the Apple Developer Portal and iTunes Connect... [14:21:54]: Starting login with user '[email protected]' +----------------+--------------------------------------+ | Detected Values | +----------------+--------------------------------------+ | Apple ID |[email protected] | | App Name | xxx | | App Identifier | com.xxx.xxx | | Project | /Users/lisong/Desktop/xxx/x | | | xx.xcodeproj | +----------------+--------------------------------------+ [14:22:06]: Please confirm the above values (y/n) y [14:22:09]: Created new file './fastlane/Appfile'. Edit it to manage your preferred app metadata information. [14:22:09]: Loading up 'deliver', this might take a few seconds [14:22:09]: Login to iTunes Connect ([email protected]) [14:22:13]: Login successful +-----------------------+------------------------+ | deliver 2.30.1 Summary | +-----------------------+------------------------+ | screenshots_path | ./fastlane/screenshots | | metadata_path | ./fastlane/metadata | | username | [email protected] | | app_identifier | com.xxx.xxx | | edit_live | false | | platform | ios | | skip_binary_upload | false | | skip_screenshots | false | | skip_metadata | false | | force | false | | submit_for_review | false | | automatic_release | false | | dev_portal_team_id | WKR87TTKML | | overwrite_screenshots | false | +-----------------------+------------------------+ [14:22:21]: Writing to 'fastlane/metadata/zh-Hans/description.txt' ... [14:22:21]: Writing to 'fastlane/metadata/review_information/notes.txt' [14:22:21]: Successfully created new configuration files. [14:22:22]: Successfully downloaded large app icon [14:22:22]: Downloading all existing screenshots... [14:22:27]: Downloading existing screenshot '1_iphone4_1.1.jpg' for language 'zh-Hans' ··· [14:22:34]: Downloading existing screenshot '5_iphone6_5.5.jpg' for language 'zh-Hans' [14:22:34]: Successfully downloaded all existing screenshots [14:22:34]: Successfully created new Deliverfile at path 'fastlane/Deliverfile' [14:22:34]: $ xcodebuild -list -project ./xxx.xcodeproj [14:22:35]: 'snapshot' not enabled. [14:22:35]: 'cocoapods' enabled. [14:22:35]: 'carthage' not enabled. [14:22:35]: Created new file './fastlane/Fastfile'. Edit it to manage your own deployment lanes. [14:22:35]: fastlane will collect the number of errors for each action to detect integration issues [14:22:35]: No sensitive/private information will be uploaded [14:22:35]: Learn more at https://github.com/fastlane/fastlane#metrics [14:22:35]: Successfully finished setting up fastlane
在 "Your Apple ID" 這一步輸入蘋果開發者賬號。在“Please confirm the above values”這一步,確認資訊,沒問題輸入 y。然後,fastlane 會進行一系列的初始化操作,包括下載 App Store 上的元資料和截圖檔案。
等待初始化完成之後,工程目錄下就多了一個 fastlane目錄,其內容如下:
fastlane目錄
咱們來看兩個主要的,Appfile和Fastfile。
Appfile
Appfile用來存放app_identifier,apple_id和team_id。 瞭解詳情,它的格式是這樣的:
app_identifier "com.xxx.xxx" # app的bundle identifier apple_id "[email protected]" # 你的Apple ID team_id "XXXXXXXXXX" # Team ID ···
你也可以為每個lane(後面會講到)提供不同的 app_identifier, apple_id 和 team_id,例如:
app_identifier "com.aaa.aaa" apple_id "[email protected]" team_id "AAAAAAAAAA" for_lane :inhouse do app_identifier "com.bbb.bbb" apple_id "[email protected]" team_id "AAAAAAAAAA" end
這裡就是為Fastfile中定義的:inhouse設定單獨的資訊。
Fastfile
Fastfile管理你所建立的 lane ,瞭解詳情。它的格式是這樣的:
··· # 自動更新fastlane 工具 # update_fastlane #需要的fastlane的最小版本,在每次執行之後會檢查是否有新版本,如果有會在最後末尾追加新版本提醒 fastlane_version "2.30.1" #預設使用平臺是 ios,也就是說檔案可以定義多個平臺 default_platform :ios platform :ios do before_all do # ENV["SLACK_URL"] = "https://hooks.slack.com/services/..." cocoapods end desc "Runs all the tests" lane :test do scan end desc "提交一個新的Beta版本到 Apple TestFlight" desc "This will also make sure the profile is up to date" lane :beta do # match(type: "appstore") # more information: https://codesigning.guide gym(scheme: "Docment") # Build your app - more options available pilot # sh "your_script.sh" end desc "部署一個新版本到App Store" lane :release do # match(type: "appstore") # snapshot gym(scheme: "Docment") # Build your app - more options available deliver(force: true) # frameit end # 你可以定義自己的lane #執行lane成功後的回撥 after_all do |lane| # slack( # message: "Successfully deployed new App Update." # ) end # 如果流程發生異常會走這裡並終止 error do |lane, exception| # slack( # message: exception.message, # success: false # ) end end
我們也可以定義一個自己的lane:
desc "企業版" lane :inHouse do gym(scheme: "XXX", export_method:"enterprise", output_directory "./build", # 打包後的 ipa 檔案存放的目錄 output_name "XXX" # ipa 檔名 ) end
其中一個lane就是一個任務,裡面是一個個的action組成的工作流。
利用目前支援的工具可以做所有包含自動化和可持續化構建的每個環節,例如:
-
scan 自動化測試工具,很好的封裝了 Unit Test
-
sigh 針對於 iOS 專案開發證書和 Provision file 的下載工具
-
match 同步團隊每個人的證書和 Provision file 的超讚工具
-
gym 針對於 iOS 編譯打包生成 ipa 檔案
-
deliver 用於上傳應用的二進位制程式碼,應用截圖和元資料到 App Store
-
snapshot 可以自動化iOS應用在每個裝置上的本地化截圖過程
執行
定義完lane之後怎麼執行呢?開啟終端,切換到專案的根目錄:執行fastlane lane'name就可以了。成功之後會在相應的路徑下生成ipa檔案,如果報錯的話就根據錯誤資訊好好檢視文件。
其他
1、這裡是官方提供的一些例子。
2、想了解fastlane命令的話可以執行$ fastlane --help
3、檢視可用任務的列表,可以執行命令$ fastlane lanes
4、fastlane也提供了很多外掛方便我們使用,例如pgyer(釋出app到蒲公英)。我們也可以打完包直接傳到蒲公英上,具體的可以看蒲公英提供的文件。
如果你感覺有些外掛不符合自己的情況,你甚至可以自定義外掛
5、多個 lane 的話實際上是可以相互呼叫的,這個其實特別實用。例如:
default_platform :ios platform :ios do lane :prepare do cocoapods match end desc 'fastlane build' 'fastlane build type:adhoc' lane :build do |options| # 呼叫上面的 prepare 任務 prepare case options[:type] when 'adhoc' adhoc else appstore end end lane : adhoc do ··· end lane : appstore do ··· end end
6、我們可以在 Fastfile 檔案中新增一個函式來設定version號和build號。
default_platform :ios def prepare_version(options) increment_version_number( version_number: options[:version] ) increment_build_number( build_number: options[:build] ) end
然後可以在一個lane中使用這個函式:
lane :appstore do |options| ··· prepare_version(options) ··· end
然後執行這個lane的時候:
$ fastlane appstore version:2.4.0 build:2.0