使用 Fastlane 將 iOS 應用程式發布給測試人員

您可以使用 fastlane 這個開放原始碼平台自動建構及發布 iOS 和 Android 應用程式。這個範例遵循 Fastfile 中定義的簡易操作說明。設定快速車道和 Fastfile 後,您可以整合應用程式發布功能與快速車道設定。

步驟 1:設定 Fastlane

  1. 安裝並設定 Quicklane

  2. 如要將應用程式發布新增至 Quicklane 設定,請在 iOS 專案的根目錄中執行下列指令:

    fastlane add_plugin firebase_app_distribution

    如果指令提示您有選項,請選取 Option 3: RubyGems.org

步驟 2:使用 Firebase 進行驗證

您必須先以下列其中一種方式透過 Firebase 專案驗證,才能使用 Fastlane 外掛程式。根據預設,如果未使用其他驗證方法,Fastlane 外掛程式會尋找 Firebase CLI 中的憑證。

步驟 3:設定 Fastfile 並發布應用程式

  1. ./fastlane/Fastfile 車道中新增 firebase_app_distribution 區塊。請使用下列參數設定發布作業:
    firebase_app_distribution 參數
    app

    只有在應用程式不含 Firebase 設定檔 (GoogleService-Info.plist) 時才需要:應用程式的 Firebase 應用程式 ID。您可以在 Firebase 控制台的「一般設定」頁面中找到應用程式 ID。

    app: "1:1234567890:ios:0a1b2c3d4e5f67890"
    googleservice_info_plist_path

    GoogleService-Info.plist 檔案的路徑,相對於封存的產品路徑。預設值為 GoogleService-Info.plist

    如未指定 app 參數,這個檔案可用來取得應用程式的 Firebase 應用程式 ID。

    firebase_cli_token

    使用 Firebase CLI 驗證持續整合環境時列印的更新權杖。詳情請參閱「將 CLI 與持續整合系統搭配使用」一文。

    service_credentials_file

    Google 服務帳戶 JSON 檔案的路徑。請參閱上方說明,瞭解如何使用服務帳戶憑證進行驗證

    ipa_path

    取代 apk_path (已淘汰)。要上傳 IPA 檔案的絕對路徑。如未指定,Fastlane 會從產生檔案的車道決定檔案的位置。

    release_notes
    release_notes_file

    這個版本的版本資訊。

    您可以直接指定版本資訊:

    release_notes: "Text of release notes"

    或指定純文字檔的路徑:

    release_notes_file: "/path/to/release-notes.txt"
    testers
    testers_file

    您要邀請的測試人員的電子郵件地址。

    您可以將測試人員指定為以半形逗號分隔的電子郵件地址清單:

    testers: "ali@example.com, bri@example.com, cal@example.com"

    或者,您也可以指定純文字檔案的路徑,該檔案包含以半形逗號分隔的電子郵件地址清單:

    testers_file: "/path/to/testers.txt"
    groups
    groups_file

    要邀請的測試人員群組 (請參閱「管理測試人員」)。群組是以「群組別名」指定,您可以在 Firebase 控制台中查詢。

    您可以使用逗號分隔的清單指定這些群組:

    groups: "qa-team, trusted-testers"

    或者,您也可以指定純文字檔案的路徑,該檔案包含以半形逗號分隔的群組名稱清單:

    groups_file: "/path/to/groups.txt"
    test_devices
    test_devices_file

    自動化測試人員 Beta 版功能包含下列發布類型。

    您要發布版本的測試裝置 (請參閱「自動化測試」)。

    您可以將測試裝置指定為以半形分號分隔的測試裝置清單:

    test_devices: "model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait"

    或者,您也可以指定包含以半形分號分隔的測試裝置清單的純文字檔案路徑:

    test_devices_file: "/path/to/test-devices.txt"
    test_username

    要在自動化測試期間自動登入的使用者名稱。

    test_password
    test_password_file

    用於自動化測試期間的自動登入密碼。

    或者,您也可以指定含有密碼的純文字檔路徑:

    test_password_file: "/path/to/test-password.txt"
    test_username_resource

    使用者名稱欄位的資源名稱,用於在自動化測試期間自動登入。

    test_password_resource

    自動化測試期間自動登入的密碼欄位資源名稱。

    test_non_blocking

    以非同步方式執行自動化測試。前往 Firebase 控制台查看自動測試結果。

    debug

    布林值標記。您可以將這個項目設為 true,以便列印詳細偵錯輸出內容。

例如:

platform :ios do
    desc "My awesome app"
    lane :distribute do
        build_ios_app(...)
        # build_ios_app is a built-in fastlane action.

        release = firebase_app_distribution(
            app: "1:123456789:ios:abcd1234",
            testers: "tester1@company.com, tester2@company.com",
            release_notes: "Lots of amazing new features to test out!"
        )

    end
end

如要向測試人員提供版本,請執行您的車道:

fastlane <lane>

動作的傳回值是代表已上傳版本的雜湊值。此雜湊也可以使用 lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]。如要進一步瞭解此雜湊中的可用欄位,請參閱 REST API 說明文件

發布版本後,Fastlane 外掛程式會輸出下列連結。這些連結可協助您管理二進位檔,並確保測試人員和其他開發人員擁有正確的版本:

  • 顯示單一版本的 Firebase 控制台連結。您可以將這個連結分享給貴機構的其他開發人員。
  • 測試人員體驗中的版本連結 (iOS 網頁片段),可讓測試人員查看版本資訊,並在裝置上安裝應用程式。測試人員需要版本存取權才能使用這個連結。
  • 直接下載並安裝應用程式二進位檔 (IPA 檔案) 的已簽署連結。連結將於一小時後失效。

發布版本後,即可在 Firebase 控制台的「應用程式發布」資訊主頁中找到 150 天。當版本到期後 30 天,控制台和測試人員測試裝置的版本清單中會顯示到期通知。

先前未受邀測試應用程式的測試人員,會收到入門電子郵件邀請。現有測試人員會收到新版本可供測試的電子郵件通知。如要瞭解如何安裝測試應用程式,請參閱「以測試人員身分進行設定」。您可以監控每位測試人員的狀態,判斷他們是否接受邀請,以及是否在 Firebase 控制台下載應用程式。

(選用) 如要在每次應用程式發布中建立新版本時,自動遞增版本號碼,可以使用 firebase_app_distribution_get_latest_release 動作和 increment_build_number 動作。以下程式碼提供如何自動遞增版本號碼的範例:

lane :increment_version do
  latest_release = firebase_app_distribution_get_latest_release(
    app: "<your Firebase app ID>"
  )
  increment_build_number({ build_number: latest_release[:buildVersion].to_i + 1 })
end

如要進一步瞭解這個 Fastlane 外掛程式功能,請參閱「取得應用程式最新版本的相關資訊」。

步驟 4 (選用)。管理發布版本的測試人員

您可以使用 Fastfile 檔案或直接執行 Fastlane 動作,為專案或群組新增及移除測試人員。執行動作會直接覆寫 Fastfile 中設定的值。

將測試人員新增至 Firebase 專案後,即可將其新增至個別版本。從 Firebase 專案中移除的測試人員將無法再存取專案中的版本,但他們可能會保留一段時間的存取權。

如果測試人員數量較多,建議您使用群組。

使用 Fastfile

# Use lanes to add or remove testers from a project.
lane(:add_testers) do
  firebase_app_distribution_add_testers(
    emails: "foo@google.com,bar@google.com"
    # or file: "/path/to/testers.txt"
    group_alias: "qa-team" # (Optional) add testers to this group
  )
end

lane(:remove_testers) do
  firebase_app_distribution_remove_testers(
    emails: "foo@google.com,bar@google.com"
    # or file: "/path/to/testers.txt"
    group_alias: "qa-team" # (Optional) remove testers from this group only
  )
end
# Add or remove testers with the terminal
$ fastlane add_testers
$ fastlane remove_testers

執行 Quicklane 動作

fastlane run firebase_app_distribution_create_group display_name:"QA Team" alias:"qa-team"
fastlane run firebase_app_distribution_add_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"
fastlane run firebase_app_distribution_remove_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"
fastlane run firebase_app_distribution_delete_group alias:"qa-team"

您也可以用 --file="/path/to/testers.txt (而非 --emails) 指定測試人員。

firebase_app_distribution_add_testersfirebase_app_distribution_remove_testers 工作也接受下列引數:

  • project_name:您的 Firebase 專案編號。
  • group_alias (選用):如果有指定,系統會將測試人員新增至指定群組 (或從中移除)。
  • service_credentials_file:Google 服務憑證檔案的路徑。
  • firebase_cli_token:Firebase CLI 的驗證權杖。

service_credentials_filefirebase_cli_token 與上傳動作使用的引數相同。

步驟 5 (選用)。取得應用程式最新版本的相關資訊

您可以使用 firebase_app_distribution_get_latest_release 動作擷取「應用程式發布」中應用程式最新版本的相關資訊,包括應用程式版本資訊、版本資訊和建立時間。用途包括自動增加版本,並沿用上一版的版本資訊。

動作的傳回值是代表最新版本的雜湊值。此雜湊也可以使用 lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]。如要進一步瞭解此雜湊中的可用欄位,請參閱 REST API 說明文件

參數

firebase_app_distribution_get_latest_release 參數
app

只有在應用程式不含 Firebase 設定檔 (GoogleService-Info.plist) 時才需要:應用程式的 Firebase 應用程式 ID。您可以在 Firebase 控制台的「一般設定」頁面中找到應用程式 ID。

app: "1:1234567890:ios:0a1b2c3d4e5f67890"
googleservice_info_plist_path

GoogleService-Info.plist 檔案的路徑,相對於封存的產品路徑。預設值為 GoogleService-Info.plist

如未指定 app 參數,這個檔案可用來取得應用程式的 Firebase 應用程式 ID。

firebase_cli_token

使用 Firebase CLI 驗證持續整合環境時列印的更新權杖。詳情請參閱「將 CLI 與持續整合系統搭配使用」一文。

service_credentials_file

Google 服務帳戶 JSON 檔案的路徑。請參閱前述說明文件,瞭解如何使用服務帳戶憑證進行驗證

service_credentials_json_data

Google 服務帳戶的 JSON 檔案內容。請參閱前述說明文件,瞭解如何使用服務帳戶憑證進行驗證

debug

布林值標記。您可以將這個項目設為 true,以便列印詳細偵錯輸出內容。

後續步驟