เผยแพร่แอป Android ให้ผู้ทดสอบโดยใช้ Fastlane

เอกสารนี้อธิบายวิธีเผยแพร่บิลด์ APK ให้ผู้ทดสอบโดยใช้ fastlane ซึ่งเป็นแพลตฟอร์มโอเพนซอร์สที่ทำงานแบบอัตโนมัติในการสร้างและเผยแพร่แอป iOS และ Android เอกสารนี้เป็นไปตามวิธีการที่ระบุไว้ใน Fastfile หลังจากตั้งค่า Fastlane และ Fastfile แล้ว คุณจะผสานรวม App Distribution กับการกําหนดค่า Fastlane ได้

ก่อนเริ่มต้น

เพิ่ม Firebase ลงในโปรเจ็กต์ Android หากยังไม่ได้ดำเนินการ

หากไม่ได้ใช้ผลิตภัณฑ์ Firebase อื่นๆ คุณก็สร้างโปรเจ็กต์และลงทะเบียนแอปได้เพียงเท่านี้ แต่หากตัดสินใจที่จะใช้ผลิตภัณฑ์เพิ่มเติมในอนาคต โปรดทําตามขั้นตอนทั้งหมดในหน้าเว็บที่ลิงก์ไว้ด้านบน

ขั้นตอนที่ 1 ตั้งค่า Fastlane

1. ติดตั้งและตั้งค่า Fastlane

2. หากต้องการเพิ่ม App Distribution ลงในการกำหนดค่า Fastlane ให้เรียกใช้คำสั่งต่อไปนี้จากรูทของโปรเจ็กต์ Android

   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 ของแอป คุณดูรหัสแอปได้ในคอนโซล Firebase ในหน้าการตั้งค่าทั่วไป app: "1:1234567890:android:0a1b2c3d4e5f67890"
   firebase_cli_token	โทเค็นรีเฟรชที่พิมพ์เมื่อคุณตรวจสอบสิทธิ์สภาพแวดล้อม CI ด้วย Firebase CLI (อ่านข้อมูลเพิ่มเติมที่ใช้ CLI กับระบบ CI)
   service_credentials_file	เส้นทางไปยังไฟล์ JSON ของบัญชีบริการ Google ดูวิธีตรวจสอบสิทธิ์โดยใช้ข้อมูลเข้าสู่ระบบบัญชีบริการได้ที่ด้านบน
   android_artifact_type	ระบุประเภทไฟล์ Android (APK หรือ AAB)
   android_artifact_path	แทนที่ apk_path (เลิกใช้งานแล้ว) เส้นทางสัมบูรณ์ไปยังไฟล์ APK หรือ AAB ที่ต้องการอัปโหลด หากไม่ระบุ 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	การเผยแพร่ประเภทต่อไปนี้เป็นส่วนหนึ่งของฟีเจอร์เบต้าสำหรับผู้ทดสอบอัตโนมัติ อุปกรณ์ทดสอบที่คุณต้องการแจกจ่ายบิลด์ให้ (ดูการทดสอบอัตโนมัติ) คุณสามารถระบุอุปกรณ์ทดสอบเป็นรายการอุปกรณ์ทดสอบที่คั่นด้วยเครื่องหมายอัฒภาค ดังนี้ 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 :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

หากต้องการให้ผู้ทดสอบใช้งานบิลด์ได้ ให้เรียกใช้เลน โดยทำดังนี้

fastlane <lane>

ค่าที่แสดงผลของการดำเนินการคือแฮชที่แสดงถึงรุ่นที่อัปโหลด แฮชนี้ยังใช้ lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE] ได้ด้วย ดูข้อมูลเพิ่มเติมเกี่ยวกับฟิลด์ที่ใช้ได้ในแฮชนี้ได้ในเอกสารประกอบเกี่ยวกับ REST API

ปลั๊กอิน Fastlane จะแสดงลิงก์ต่อไปนี้หลังจากการอัปโหลดรุ่น ลิงก์เหล่านี้จะช่วยคุณจัดการไบนารีและตรวจสอบว่าผู้ทดสอบและนักพัฒนาซอฟต์แวร์รายอื่นๆ มีรุ่นที่ถูกต้อง

• ลิงก์ไปยังคอนโซล Firebase ที่แสดงผลงานเดียว คุณสามารถแชร์ลิงก์นี้กับนักพัฒนาแอปคนอื่นๆ ในองค์กรได้
• ลิงก์ไปยังรุ่นในประสบการณ์การใช้งานของผู้ทดสอบ (แอป Android เวอร์ชันเนทีฟ) ซึ่งช่วยให้ผู้ทดสอบดูหมายเหตุรุ่นและติดตั้งแอปลงในอุปกรณ์ได้ ผู้ทดสอบต้องมีสิทธิ์เข้าถึงรุ่นจึงจะใช้ลิงก์ได้
• ลิงก์ที่รับรองแล้วซึ่งจะดาวน์โหลดและติดตั้งไฟล์ไบนารีของแอป (ไฟล์ APK หรือ AAB) โดยตรง ลิงก์จะหมดอายุใน 1 ชั่วโมง

หลังจากเผยแพร่บิลด์แล้ว บิลด์จะอยู่ในApp Distributionแดชบอร์ดของคอนโซล Firebase เป็นเวลา 150 วัน เมื่อบิลด์เหลือเวลา 30 วันจะหมดอายุ ประกาศการหมดอายุจะปรากฏในคอนโซลและในรายการบิลด์ของผู้ทดสอบในอุปกรณ์ทดสอบ

ผู้ทดสอบที่ก่อนหน้านี้ไม่ได้ได้รับเชิญให้ทดสอบแอปจะได้รับคำเชิญทางอีเมลให้เริ่มต้นใช้งาน ผู้ทดสอบปัจจุบันจะได้รับการแจ้งเตือนทางอีเมลว่าบิลด์ใหม่พร้อมให้ทดสอบแล้ว ดูวิธีติดตั้งแอปทดสอบได้ที่คู่มือการตั้งค่าผู้ทดสอบ คุณสามารถตรวจสอบสถานะของผู้ทดสอบแต่ละคนเพื่อดูว่ายอมรับคำเชิญหรือไม่ และดาวน์โหลดแอปในคอนโซล Firebase หรือไม่

(ไม่บังคับ) หากต้องการเพิ่มหมายเลขบิลด์โดยอัตโนมัติทุกครั้งที่สร้างรุ่นใหม่ในการเผยแพร่แอป ให้ใช้การดำเนินการ firebase_app_distribution_get_latest_release และincrement_version_code ปลั๊กอิน Fastlane เป็นต้น โค้ดต่อไปนี้แสดงตัวอย่างวิธีเพิ่มหมายเลขบิลด์โดยอัตโนมัติ

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับการดำเนินการ firebase_app_distribution_get_latest_release ได้ที่ดูข้อมูลเกี่ยวกับรุ่นล่าสุดของแอป

ขั้นตอนที่ 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

เรียกใช้การดำเนินการ 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"

นอกจากนี้ คุณยังระบุผู้ทดสอบได้โดยใช้ --file="/path/to/testers.txt แทน --emails

งาน firebase_app_distribution_add_testers และ firebase_app_distribution_remove_testers ยังยอมรับอาร์กิวเมนต์ต่อไปนี้ด้วย

• project_name: หมายเลขโปรเจ็กต์ Firebase
• group_alias (ไม่บังคับ): หากระบุ ระบบจะเพิ่ม (หรือนำออก) ผู้ทดสอบไปยัง (หรือจาก) กลุ่มที่ระบุ
• service_credentials_file: เส้นทางไปยังไฟล์ข้อมูลเข้าสู่ระบบบริการของ Google
• firebase_cli_token: โทเค็นการตรวจสอบสิทธิ์สําหรับ Firebase CLI

service_credentials_file และ firebase_cli_token เป็นอาร์กิวเมนต์เดียวกันที่การดำเนินการอัปโหลดใช้

ขั้นตอนที่ 5 (ไม่บังคับ) ดูข้อมูลเกี่ยวกับรุ่นล่าสุดของแอป

คุณสามารถใช้การดำเนินการ firebase_app_distribution_get_latest_release เพื่อดึงข้อมูลเกี่ยวกับรุ่นล่าสุดของแอปในการเผยแพร่แอป ซึ่งรวมถึงข้อมูลเวอร์ชันของแอป บันทึกประจำรุ่น และเวลาสร้าง กรณีการใช้งานรวมถึงการเพิ่มเวอร์ชันโดยอัตโนมัติและนําหมายเหตุรุ่นจากรุ่นก่อนหน้ามาใช้

ค่าที่แสดงผลของการดำเนินการคือแฮชที่แสดงถึงรุ่นล่าสุด แฮชนี้ยังใช้ lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE] ได้ด้วย ดูข้อมูลเพิ่มเติมเกี่ยวกับฟิลด์ที่ใช้ได้ในแฮชนี้ได้ในเอกสารประกอบเกี่ยวกับ REST API

พารามิเตอร์

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

ขั้นตอนถัดไป

• ใช้ความคิดเห็นในแอปเพื่อให้ผู้ทดสอบส่งความคิดเห็นเกี่ยวกับแอปของคุณได้ง่ายๆ (รวมถึงภาพหน้าจอ)

• ดูวิธีแสดงการแจ้งเตือนในแอปให้ผู้ทดสอบทราบเมื่อมีเวอร์ชันใหม่ของแอปให้ติดตั้ง

• ดูแนวทางปฏิบัติแนะนำสำหรับการจัดจำหน่ายแอป Android ให้แก่ผู้ทดสอบ QA โดยใช้ CI/CD