הפצת אפליקציות ל-iOS לבודקים באמצעות fastlane

אפשר להפיץ גרסאות build לבוחנים באמצעות fastlane, פלטפורמה בקוד פתוח שמבצעת אוטומציה של בנייה ושחרור של אפליקציות ל-iOS ול-Android. ההוראות במדריך הזה מבוססות על ההוראות שמוגדרות בFastfile. אחרי שמגדירים את fastlane ואת Fastfile, אפשר לשלב את App Distribution עם ההגדרה של fastlane.

לפני שמתחילים

1. אם עדיין לא הוספתם את Firebase לפרויקט Apple, אתם צריכים להוסיף אותו.

   אם אתם לא משתמשים במוצרים אחרים של Firebase, אתם צריכים רק ליצור פרויקט ולרשום את האפליקציה. עם זאת, אם תחליטו להשתמש במוצרים נוספים בעתיד, הקפידו לבצע את כל השלבים בדף שאליו קישרנו למעלה.

2. פותחים את הדף App Distribution במסוף Firebase. כשמוצגת בקשה, בוחרים את פרויקט Firebase, בוחרים את האפליקציה באמצעות מחליף האפליקציות ולוחצים על Get started (תחילת העבודה).

שלב 1. הגדרת fastlane

1. התקנה והגדרה של fastlane

2. כדי להוסיף את App Distribution להגדרות של fastlane, מריצים את הפקודה הבאה מתיקיית הבסיס של פרויקט iOS:

   fastlane add_plugin firebase_app_distribution

   אם הפקודה מציגה אפשרות, בוחרים באפשרות Option 3: RubyGems.org.

שלב 2. אימות באמצעות Firebase

כדי להשתמש בתוסף fastlane, צריך קודם לבצע אימות בפרויקט Firebase באחת מהדרכים הבאות. כברירת מחדל, הפלאגין fastlane מחפש פרטי כניסה מ-CLI של Firebase אם לא נעשה שימוש בשיטת אימות אחרת.

שלב 3. הגדרת Fastfile והפצת האפליקציה

1. ב./fastlane/Fastfile נתיב, מוסיפים בלוק firebase_app_distribution. משתמשים בפרמטרים הבאים כדי להגדיר את ההפצה:

   פרמטרים של הפצת אפליקציות ב-Firebase
   app	נדרש רק אם האפליקציה לא מכילה קובץ תצורה של Firebase ‏ (GoogleService-Info.plist): מזהה האפליקציה ב-Firebase. אפשר למצוא את מזהה האפליקציה במסוף Firebase, בדף הגדרות כלליות. app: "1:1234567890:ios:0a1b2c3d4e5f67890"
   googleservice_info_plist_path	הנתיב לקובץ GoogleService-Info.plist, ביחס לנתיב של המוצר בארכיון. מוגדר כ-GoogleService-Info.plist כברירת מחדל. הקובץ משמש לקבלת מזהה האפליקציה שלכם ב-Firebase אם הפרמטר app לא צוין.
   firebase_cli_token	טוקן רענון שמוצג כשמאמתים את סביבת ה-CI באמצעות Firebase CLI (מידע נוסף זמין במאמר שימוש ב-CLI עם מערכות CI).
   service_credentials_file	הנתיב לקובץ ה-JSON של חשבון השירות שלכם ב-Google. למעלה מוסבר איך מבצעים אימות באמצעות פרטי כניסה של חשבון שירות.
   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	מכשירי הבדיקה שרוצים להריץ עליהם בדיקות של סוכן App Testing. אפשר לציין את מכשירי הבדיקה כרשימה של מפרטי מכשירים שמופרדים באמצעות נקודה ופסיק: test_devices: "model=shiba,version=34,locale=en,orientation=portrait" אפשר גם לציין את הנתיב לקובץ טקסט פשוט שמכיל רשימה של מכשירי בדיקה שמופרדים באמצעות נקודה-פסיק: test_devices_file: "/path/to/test-devices.txt"
   test_username	שם המשתמש לכניסה אוטומטית שישמש במהלך בדיקות של סוכן App Testing.
   test_password test_password_file	הסיסמה לכניסה אוטומטית שתשמש במהלך בדיקות של סוכן App Testing. אפשר גם לציין את הנתיב לקובץ טקסט פשוט שמכיל סיסמה: test_password_file: "/path/to/test-password.txt"
   test_username_resource	שם המשאב של השדה של שם המשתמש לכניסה אוטומטית, לשימוש במהלך בדיקות של סוכן App Testing.
   test_password_resource	שם המשאב של שדה הסיסמה לכניסה אוטומטית, לשימוש במהלך בדיקות של סוכן App Testing.
   test_non_blocking	אם מגדירים את האפשרות הזו כשמריצים בדיקות באמצעות סוכן App Testing, הפקודה תתחיל את הבדיקות ואז תחזור מיד במקום לחכות שהן יסתיימו. כדי לראות את תוצאות הבדיקה, נכנסים למסוף 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

כדי להפוך את גרסת ה-build לזמינה לבודקים, מריצים את הנתיב:

fastlane <lane>

הערך שמוחזר מהפעולה הוא גיבוב שמייצג את הגרסה שהועלתה. הגיבוב הזה זמין גם באמצעות lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]. מידע נוסף על השדות הזמינים בגיבוב הזה מופיע במסמכי התיעוד של API בארכיטקטורת REST.

התוסף fastlane מפיק את הקישורים הבאים אחרי העלאת הגרסה. הקישורים האלה עוזרים לכם לנהל קבצים בינאריים ולוודא שהבודקים ומפתחים אחרים מקבלים את הגרסה הנכונה:

• קישור למסוף Firebase שבו מוצג פריט תוכן יחיד. אפשר לשתף את הקישור הזה עם מפתחים אחרים בארגון.
• קישור לגרסה בחוויית הבודקים (קובץ web clip ב-iOS) שמאפשר לבודקים לראות את הערות הגרסה ולהתקין את האפליקציה במכשיר שלהם. הבודק צריך גישה לגרסה כדי להשתמש בקישור.
• קישור חתום שמוריד ישירות את קובץ הבינארי של האפליקציה (קובץ IPA) ומתקין אותו. התוקף של הקישור יפוג אחרי שעה.

אחרי שמפיצים את הגרסה, היא זמינה בלוח הבקרה App Distribution של Firebase למשך 150 ימים. כשנותרו 30 יום עד לתפוגה של הגרסה, מופיעה הודעת תפוגה במסוף וברשימת הגרסאות של הבודק במכשיר הבדיקה.

בודקים שלא הוזמנו בעבר לבדוק את האפליקציה מקבלים הזמנות באימייל כדי להתחיל. בודקים קיימים מקבלים התראות באימייל על כך שגרסת build חדשה מוכנה לבדיקה. במאמר איך מצטרפים לבודקים מוסבר איך להתקין את אפליקציית הבדיקה. אתם יכולים לעקוב אחרי הסטטוס של כל בודק כדי לדעת אם הוא אישר את ההזמנה ואם הוא הוריד את האפליקציה במסוף Firebase.

(אופציונלי) כדי להגדיל אוטומטית את מספר ה-build בכל פעם שיוצרים גרסה חדשה ב-App Distribution, אפשר להשתמש בפעולה firebase_app_distribution_get_latest_release ובפעולה increment_build_number. בדוגמה הבאה אפשר לראות איך להגדיל באופן אוטומטי את מספר Build:

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

הרצת פעולות של 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_number: מספר הפרויקט ב-Firebase.
• ‫group_alias (אופציונלי): אם מציינים קבוצה, הבודקים מתווספים לקבוצה שצוינה (או מוסרים ממנה).
• ‫service_credentials_file: הנתיב לקובץ פרטי הכניסה של שירות Google.
• ‫firebase_cli_token: אסימון אימות ל-CLI של Firebase.

‫service_credentials_file ו-firebase_cli_token הם אותם ארגומנטים שמשמשים לפעולת ההעלאה.

שלב 5 (אופציונלי). קבלת מידע על הגרסה האחרונה של האפליקציה

אפשר להשתמש בפעולה firebase_app_distribution_get_latest_release כדי לאחזר מידע על הגרסה האחרונה של האפליקציה ב-הפצת אפליקציות, כולל פרטים על גרסת האפליקציה, הערות לגבי הגרסה וזמן היצירה. דוגמאות לתרחישי שימוש: הגדלת מספר הגרסה באופן אוטומטי והעברת הערות הגרסה מהגרסה הקודמת.

הערך שמוחזר מהפעולה הוא גיבוב שמייצג את הגרסה האחרונה. הגיבוב הזה זמין גם באמצעות lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]. מידע נוסף על השדות הזמינים בגיבוב הזה מופיע במסמכי התיעוד של API בארכיטקטורת REST.

פרמטרים

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

השלבים הבאים

• כדי לרשום עוד מכשירים באופן ידני או באמצעות תוכנה, אפשר לעיין במאמר בנושא רישום מכשירי iOS נוספים.

• שיטות מומלצות להפצת אפליקציות ל-iOS לבוחני QA באמצעות CI/CD ו-fastlane