נתוני גרסה של Android Studio

במסמך הזה מוסבר איך ליצור את נתוני הגרסה של Android Studio.

יעד

כדי ליצור הערות מפורטות על גרסת עדכון לקומיטים ממאגר GitHub.

הוראות

חשוב לפעול לפי ההוראות האלה באופן מלא ורציף.

שלב 1: משכפלים או מעדכנים את מאגר המידע

בודקים אם יש תיקייה בשם studio-main בפרויקט. אם הוא לא קיים, משכפלים את מאגר studio-main באמצעות הפקודה הבאה:

git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main

אם הספרייה כבר קיימת, מרעננים אותה על ידי משיכת התוכן של המאגר מ-GitHub.

אני רוצה לדעת מה הסטטוס של studio-main לפני שאמשיך.

שלב 2: בודקים את מאגר המידע

בודקים את התוכן של המאגר.

שלב 3: מקבלים את הקומיטים

קבל את כל הקומיטים שנשלחו למאגר studio-main במהלך פרק הזמן שציינתי. אשמח לדעת את המספר לפני שאמשיך. תמיד משתמשים בפקודה wc -l לספירה.

1. זיהוי קומיטים של יעד: מתוך יומן ה-git, מחלצים את בלוק הקומיט המלא עבור כל קומיט שמכיל את המחרוזת המדויקת Relnote: , כאשר הוא שם המוצר שסיפקתי. אם לא אציין שם מוצר, פשוט תחפש 'הערות לגבי הגרסה'.

   'בלוק של פעולת commit' כולל את הגיבוב של ה-commit, המחבר, התאריך, הודעת ה-commit המלאה וההבדלים בקוד.

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

   ‪git log --after="" --before="" --grep="Relnote: "

   כאשר ו- הם טווח התאריכים שציינתי, ו- הוא שם המוצר שציינתי.

   אם לא מצוין שם מוצר, פשוט משתמשים בפקודה הבאה:

   git log --after="" --before="" --grep="Relnote"

3. אישור הספירה: הצגת הספירה הכוללת, הגיבובים והשמות של כל הקומיטים שזיהית. אשלח לך אישור להמשך.

שלב 4: יצירת הערות מפורטות על הגרסה

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

   • קריאת הודעת ה-commit המלאה.
   • בדיקת ההבדלים בקוד (git show ) כדי להבין את השינוי.
   • מעקב אחרי באגים מקושרים (לדוגמה, באג: 12345678) כדי לקבל הקשר נוסף.

   אני רוצה לאשר איתך לפני שאמשיך.

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

   לפני שאמשיך, אשמח לדעת אילו קומיטים מכילים מידע שקשור לתיקיית המסמכים.

3. לקבל את כל הבאגים שהוזכרו בהתחייבויות. אפשר להשתמש במידע על הבאג כדי ליצור את הערת הגרסה של הקומיט.

4. כותבים את נתוני הגרסה: לכל קומיט, כותבים נתוני גרסה שכוללים:

   • הפניה להתחייבות: לפני כל הערת גרסה, מוסיפים הערת Markdown שמכילה את הגיבוב של התחייבות המקור, כך: .

   • שם ברור: סיכום תמציתי של השינוי, באותיות רישיות בתחילת כל מילה.

   • הסבר מפורט: פסקה שבה מוסבר על מה השינוי.

   • נקודות חשובות לגבי השינוי, לפי הסדר הבא:

     א. למה: מה השתנה ולמה זה השתנה ב. ההשפעה: ההשפעה על מפתחי אפליקציות ג. מיגרציה: נתיב המיגרציה (אם יש)

   • דוגמאות קוד לפני ואחרי: אם הקומיט כולל שינוי בקוד שמשפיע על המשתמש (לדוגמה, שינויים ב-DSL בקובצי ‎ .gradle או שינויים ב-API), צריך לספק קטעי קוד ברורים ותמציתיים שמדגימים את השינוי.

   הנחיות הסגנון להערות המוצר זמינות בכתובת https://developer.android.com/studio/releases.

שלב 5: כותבים את הערות הגרסה לקובץ Markdown

1. יוצרים קובץ Markdown בשם release-notes-YYYY-MM-DDTHH:MM.md בתיקיית הבסיס של הפרויקט, כאשר YYYY-MM-DD (שנה-חודש-יום) הוא התאריך הנוכחי, T היא מפריד, ו-HH:MM (שעות:דקות בפורמט של שעון 24 שעות) היא השעה הנוכחית – בפורמט ISO 8601.
2. לכתוב הקדמה שמסבירה את המטרה של הערות המוצר.
3. לכתוב סיכום של נתוני הגרסה.
4. לכתוב את נתוני הגרסה המלאים והמעוצבים.

שלב 6: יצירת קומיט

יוצרים קובץ Fig commit לקובץ הערות הגרסה. אל תכללו מזהה באג.

שלב 7: יצירת רשימת שינויים

יוצרים CL של הקומיט.