Phân phối ứng dụng Android cho người thử nghiệm bằng cách sử dụng fastlane

Tài liệu này mô tả cách phân phối bản dựng APK cho người thử nghiệm bằng cách sử dụng fastlane , một nền tảng nguồn mở tự động hóa việc xây dựng và phát hành ứng dụng iOS và Android. Tài liệu này tuân theo các hướng dẫn được xác định trong Fastfile . Sau khi thiết lập fastlane và Fastfile , bạn có thể tích hợp Phân phối ứng dụng với cấu hình fastlane của mình.

Trước khi bắt đầu

Nếu bạn chưa có, hãy thêm Firebase vào dự án Android của bạn .

Nếu không sử dụng bất kỳ sản phẩm Firebase nào khác, bạn chỉ phải tạo dự án và đăng ký ứng dụng của mình. Tuy nhiên, nếu bạn quyết định sử dụng các sản phẩm bổ sung trong tương lai, hãy nhớ hoàn thành tất cả các bước trên trang được liên kết ở trên.

Bước 1. Thiết lập làn đường nhanh

  1. Cài đặt và thiết lập fastlane .

  2. Để thêm Phân phối ứng dụng vào cấu hình fastlane của bạn, hãy chạy lệnh sau từ thư mục gốc của dự án Android của bạn:

    fastlane add_plugin firebase_app_distribution

    Nếu lệnh nhắc bạn với một tùy chọn, hãy chọn Option 3: RubyGems.org .

Bước 2. Xác thực bằng Firebase

Trước khi có thể sử dụng plugin fastlane, trước tiên bạn phải xác thực với dự án Firebase của mình theo một trong các cách sau. Theo mặc định, plugin fastlane tìm kiếm thông tin xác thực từ Firebase CLI nếu không sử dụng phương thức xác thực nào khác.

Bước 3. Thiết lập Fastfile và phân phối ứng dụng của bạn

  1. Trong làn ./fastlane/Fastfile , hãy thêm khối firebase_app_distribution . Sử dụng các tham số sau để định cấu hình phân phối:
    tham số firebase_app_distribution
    app

    Bắt buộc : ID ứng dụng Firebase của ứng dụng của bạn. Bạn có thể tìm thấy ID ứng dụng trong bảng điều khiển Firebase, trên trang Cài đặt chung .

    app: "1:1234567890:android:0a1b2c3d4e5f67890"
    firebase_cli_token

    Mã thông báo làm mới được in khi bạn xác thực môi trường CI của mình bằng CLI Firebase (đọc Sử dụng CLI với hệ thống CI để biết thêm thông tin).

    service_credentials_file

    Đường dẫn đến tệp json tài khoản dịch vụ Google của bạn. Xem bên trên để biết cách xác thực bằng thông tin đăng nhập tài khoản dịch vụ .

    android_artifact_type

    Chỉ định loại tệp Android (APK hoặc AAB).

    android_artifact_path

    Thay thế apk_path (không dùng nữa). Đường dẫn tuyệt đối đến tệp APK hoặc AAB bạn muốn tải lên. Nếu không được chỉ định, fastlane sẽ xác định vị trí của tệp từ làn mà tệp được tạo.

    release_notes
    release_notes_file

    Ghi chú phát hành cho bản dựng này.

    Bạn có thể chỉ định trực tiếp ghi chú phát hành:

    release_notes: "Text of release notes"

    Hoặc chỉ định đường dẫn đến tệp văn bản thuần túy:

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

    Địa chỉ email của người thử nghiệm mà bạn muốn mời.

    Bạn có thể chỉ định người kiểm tra dưới dạng danh sách địa chỉ email được phân tách bằng dấu phẩy:

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

    Hoặc, bạn có thể chỉ định đường dẫn đến tệp văn bản thuần túy chứa danh sách địa chỉ email được phân tách bằng dấu phẩy:

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

    Nhóm người thử nghiệm mà bạn muốn mời (tham khảo Quản lý người thử nghiệm ). Các nhóm được chỉ định bằng cách sử dụng bí danh nhóm , bạn có thể tra cứu trong bảng điều khiển Firebase.

    Bạn có thể chỉ định các nhóm dưới dạng danh sách được phân tách bằng dấu phẩy:

    groups: "qa-team, trusted-testers"

    Hoặc, bạn có thể chỉ định đường dẫn đến tệp văn bản thuần túy chứa danh sách tên nhóm được phân tách bằng dấu phẩy:

    groups_file: "/path/to/groups.txt"
    debug

    Một lá cờ boolean. Bạn có thể đặt giá trị này thành true để in kết quả gỡ lỗi chi tiết.

platform :android do
    desc "My awesome app"
    lane :distribute do
        build_android_app(...)
        # build_android_app is a built-in fastlane action.
        release = firebase_app_distribution(
            app: "1:123456789:android:abcd1234",
            testers: "tester1@company.com, tester2@company.com",
            release_notes: "Lots of amazing new features to test out!"
        )
    end
end

Để cung cấp bản dựng cho người thử nghiệm, hãy chạy làn đường của bạn:

fastlane <lane>

Giá trị trả về của hành động là hàm băm đại diện cho bản phát hành đã tải lên. Hàm băm này cũng có sẵn bằng cách sử dụng lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE] . Để biết thêm thông tin về các trường có sẵn trong hàm băm này, hãy xem tài liệu API REST .

Plugin fastlane xuất ra các liên kết sau sau khi tải lên bản phát hành. Các liên kết này giúp bạn quản lý các tệp nhị phân và đảm bảo rằng người thử nghiệm và nhà phát triển khác có bản phát hành phù hợp:

  • Một liên kết đến bảng điều khiển Firebase hiển thị một bản phát hành. Bạn có thể chia sẻ liên kết này với các nhà phát triển khác trong tổ chức của mình.
  • Đường liên kết đến bản phát hành trong trải nghiệm của người thử nghiệm (ứng dụng gốc của Android) cho phép người thử nghiệm xem ghi chú phát hành và cài đặt ứng dụng vào thiết bị của họ. Người thử nghiệm cần có quyền truy cập vào bản phát hành để sử dụng liên kết.
  • Liên kết đã ký trực tiếp tải xuống và cài đặt tệp nhị phân của ứng dụng (tệp APK hoặc AAB). Liên kết sẽ hết hạn sau một giờ.

Sau khi bạn phân phối bản dựng của mình, bản dựng đó sẽ có sẵn trong bảng điều khiển Phân phối ứng dụng của bảng điều khiển Firebase trong 150 ngày. Khi bản dựng hết hạn sau 30 ngày, thông báo hết hạn sẽ xuất hiện trong bảng điều khiển và trong danh sách các bản dựng của người thử nghiệm trên thiết bị thử nghiệm của họ.

Những người thử nghiệm trước đây chưa được mời thử nghiệm ứng dụng sẽ nhận được lời mời qua email để bắt đầu. Những người thử nghiệm hiện tại sẽ nhận được thông báo qua email rằng bản dựng mới đã sẵn sàng để thử nghiệm. Để tìm hiểu cách cài đặt ứng dụng thử nghiệm, hãy xem hướng dẫn thiết lập người thử nghiệm . Bạn có thể theo dõi trạng thái của từng người thử nghiệm để xác định xem họ có chấp nhận lời mời hay không và liệu họ có tải xuống ứng dụng trong bảng điều khiển Firebase hay không.

(Tùy chọn) Để tự động tăng số bản dựng mỗi khi bạn tạo bản phát hành mới trong Phân phối ứng dụng, bạn có thể sử dụng hành động firebase_app_distribution_get_latest_release và, ví dụ: plugin fastlane increment_version_code . Đoạn mã sau cung cấp ví dụ về cách tự động tăng số bản dựng của bạn:

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

Để tìm hiểu thêm về hành động firebase_app_distribution_get_latest_release , hãy xem Nhận thông tin về bản phát hành mới nhất của ứng dụng của bạn .

Bước 4 (Tùy chọn). Quản lý người thử nghiệm để phân phối

Bạn có thể thêm và xóa người thử nghiệm khỏi dự án hoặc nhóm của mình bằng tệp Fastfile hoặc bằng cách chạy trực tiếp các hành động fastlane. Các hành động đang chạy sẽ ghi đè trực tiếp các giá trị được đặt trong Fastfile của bạn.

Sau khi người thử nghiệm được thêm vào dự án Firebase của bạn, bạn có thể thêm họ vào từng bản phát hành riêng lẻ. Những người thử nghiệm bị xóa khỏi dự án Firebase của bạn sẽ không còn có quyền truy cập vào các bản phát hành trong dự án của bạn nữa nhưng họ có thể giữ quyền truy cập vào các bản phát hành của bạn trong một khoảng thời gian.

Nếu bạn có số lượng lớn người thử nghiệm, bạn nên cân nhắc sử dụng nhóm.

Sử dụng 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

Chạy hành động fastlane

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"

Bạn cũng có thể chỉ định người kiểm tra bằng cách sử dụng --file="/path/to/testers.txt thay vì --emails .

Các tác vụ firebase_app_distribution_add_testers và firebase_app_distribution_remove_testers cũng chấp nhận các đối số sau:

  • project_name : Mã số dự án Firebase của bạn.
  • group_alias (tùy chọn): Nếu được chỉ định, người thử nghiệm sẽ được thêm vào (hoặc bị xóa khỏi) nhóm được chỉ định.
  • service_credentials_file : Đường dẫn đến tệp thông tin xác thực dịch vụ Google của bạn.
  • firebase_cli_token : Mã thông báo xác thực cho Firebase CLI.

service_credentials_file và firebase_cli_token là các đối số giống nhau được hành động tải lên sử dụng.

Bước 5 (Tùy chọn). Nhận thông tin về bản phát hành mới nhất của ứng dụng của bạn

Bạn có thể sử dụng hành động firebase_app_distribution_get_latest_release để tìm nạp thông tin về bản phát hành mới nhất của ứng dụng trong Phân phối ứng dụng, bao gồm thông tin phiên bản ứng dụng, ghi chú phát hành và thời gian tạo. Các trường hợp sử dụng bao gồm tự động tăng phiên bản và chuyển sang ghi chú phát hành từ bản phát hành trước.

Giá trị trả về của hành động là hàm băm đại diện cho bản phát hành mới nhất. Hàm băm này cũng có sẵn bằng cách sử dụng lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE] . Để biết thêm thông tin về các trường có sẵn trong hàm băm này, hãy xem tài liệu API REST .

Thông số

tham số firebase_app_distribution_get_latest_release
app

Bắt buộc : ID ứng dụng Firebase của ứng dụng của bạn. Bạn có thể tìm thấy ID ứng dụng trong bảng điều khiển Firebase, trên trang Cài đặt chung .

app: "1:1234567890:android:0a1b2c3d4e5f67890"
firebase_cli_token

Mã thông báo làm mới được in khi bạn xác thực môi trường CI của mình bằng CLI Firebase (đọc Sử dụng CLI với hệ thống CI để biết thêm thông tin).

service_credentials_file

Đường dẫn đến tệp json tài khoản dịch vụ Google của bạn. Xem bên trên để biết cách xác thực bằng thông tin đăng nhập tài khoản dịch vụ .

debug

Một lá cờ boolean. Bạn có thể đặt giá trị này thành true để in kết quả gỡ lỗi chi tiết.

Bước tiếp theo