עבודה עם בעיות ובקשות משיכה

בדף הזה מוסבר איך לעבוד עם בעיות ובקשות משיכה בממשק האינטרנט של Secure Source Manager.

כדי לגשת למופע של Secure Source Manager דרך ממשק האינטרנט שלו, מעתיקים את כתובת ה-URL הבאה לסרגל הכתובות בדפדפן.

INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

מחליפים את מה שכתוב בשדות הבאים:

  • INSTANCE_ID בשם המכונה.
  • ‫PROJECT_NUMBER עם מספר הפרויקט של המופע. Google Cloud מידע על זיהוי פרויקטים זמין במאמר זיהוי פרויקטים.
  • ‫LOCATION עם האזור של המכונה.

התפקידים הנדרשים

כדי לקבל את ההרשאות שדרושות בשביל לעבוד עם בעיות ובקשות משיכה, אתם צריכים לבקש מהאדמין לתת לכם את תפקידי ה-IAM הבאים:

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

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

במאמרים בקרת גישה באמצעות IAM והענקת גישה של משתמשים למופע מוסבר איך נותנים תפקידים ב-Secure Source Manager.

הצגת בקשות מיזוג

אתם יכולים לראות את כל בקשות המיזוג שיש לכם גישה אליהן, או בקשות מיזוג למאגר ספציפי.

במאגרים ריקים אין כרטיסייה Pull requests. אחרי שמעלים ל-repository, אפשר לראות את הכרטיסייה של בקשת המשיכה.

כדי לראות בקשות למשיכת שינויים או בעיות שהוקצו לכם, עוברים לכרטיסייה בעיות או בקשות למשיכת שינויים ב-Secure Source Manager ולוחצים על הוקצו לי.

כדי לראות את בקשות המיזוג של מאגר:

  1. בממשק האינטרנט של Secure Source Manager, בוחרים את המאגר.
  2. בדף המאגר, לוחצים על הכרטיסייה Pull requests.
  3. אפשר לסנן או למיין את בקשות המשיכה באמצעות התפריטים הנפתחים המוקצה, סוג או מיון.

כדי לראות את כל בקשות המשיכה:

  1. בממשק האינטרנט של Secure Source Manager, לוחצים על הכרטיסייה בקשות משיכה.

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

יצירת בקשת מיזוג

  1. בממשק האינטרנט של Secure Source Manager, בוחרים את המאגר שרוצים ליצור עבורו בקשת משיכה.
  2. בדף המאגר, לוחצים על הכרטיסייה Pull requests.
  3. לוחצים על New pull request.
  4. בתפריט מיזוג אל, בוחרים את הענף שאליו רוצים למזג את בקשת המשיכה.
  5. בתפריט pull from (משיכה מ), בוחרים את הענף שממנו רוצים למשוך.
  6. לוחצים על New pull request.
  7. נותנים לבקשת המיזוג שם ותיאור, ומצרפים קבצים רלוונטיים.

  8. לוחצים על Create pull request.

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

עריכת פרטי בקשת משיכה

אפשר להוסיף לבקשת מיזוג בודקים, תוויות, אבני דרך, מקבל הקצאה ותאריך יעד.

כדי להוסיף כותבי ביקורות, תוויות, אבני דרך, מקבלים לטיפול:

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

העריכות נשמרות אוטומטית.

כדי לעדכן את תאריך היעד:

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

בדיקת בקשת מיזוג

בודקי קוד יכולים להוסיף תגובות, לבקש שינויים ולאשר בקשת מיזוג.

כדי לבדוק בקשת מיזוג שהוקצתה לכם:

  1. בממשק האינטרנט של Secure Source Manager, לוחצים על הכרטיסייה בקשות משיכה.
  2. לוחצים על Assigned to you (מוקצה לך).

  3. לוחצים על בקשת המשיכה שרוצים לבדוק.

    הדף Conversation ייפתח. אתם יכולים לראות את כל התגובות שהוסיף מחבר בקשת המיזוג או בודקים אחרים.

  4. כדי לראות את הקבצים ששונו ולהוסיף להם תגובות, לוחצים על הכרטיסייה Files changed (קבצים ששונו). אפשר לשנות את ההתנהגות של הרווחים הלבנים, את אפשרויות התצוגה וההשוואה על ידי לחיצה על התפריטים הנפתחים רווחים לבנים, תצוגה מפוצלת/תצוגה מאוחדת ואפשרויות השוואה.

  5. כדי להוסיף תגובה, לוחצים על סמל הפלוס ליד השורה שרוצים להוסיף לה תגובה.

  6. לוחצים על להתחלת הבדיקה.

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

    התגובות תומכות בסגנון עם Markdown.

  8. כדי לשלוח את התגובות, לאשר את בקשת המשיכה או לבקש שינויים, לוחצים על בדיקה.

  9. אפשר להוסיף תגובה כדי לסכם את השינויים, או להשאיר את התגובה ריקה ולבחור מבין האפשרויות הבאות:

    • אישור: אישור השינויים.
    • תגובה: שליחת התגובות בלי לאשר את בקשת המשיכה.

    • בקשה לשינויים: בקשה לשינויים בבקשת המיזוג.

מיזוג בקשות משיכה

  1. בדף המאגר, לוחצים על הכרטיסייה Pull requests.
  2. בוחרים את בקשת המיזוג שרוצים למזג.
  3. אם אין התנגשויות, לוחצים על Merge pull request.

הצגת הבעיות

  1. בממשק האינטרנט של Secure Source Manager, בוחרים את המאגר.
  2. בדף המאגר, לוחצים על הכרטיסייה Issues.
  3. אפשר לסנן או למיין את הבעיות באמצעות התפריטים אחראי, סוג או מיון.

יצירת בעיה

  1. בממשק האינטרנט של Secure Source Manager, בוחרים את המאגר.
  2. בדף המאגר, לוחצים על הכרטיסייה Issues.
  3. לוחצים על בעיה חדשה.
  4. מזינים את שם הבעיה ואת התיאור שלה, ואז לוחצים על יצירת בעיה.

  5. בדף פרטי הבעיה אפשר להקצות תוויות, אבני דרך, אחראים ולציין ענף או תג.

הוספת דיאגרמות באמצעות Mermaid

‫Secure Source Manager תומך בעיבוד של דיאגרמות Mermaid בקובצי Markdown (כמו README.md), בתיאורים של בקשות משיכה, בבעיות ובתגובות.

כדי להוסיף תרשים, משתמשים בmermaidבלוק קוד עם גדר:

```mermaid
graph TD
    A[Write Markdown] --> B(Click Preview Tab)
    B --> C{Does it render?}
    C -- Yes --> D[Success]
    C -- No --> E[Check Syntax]
```

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

סוגי דיאגרמות נתמכים

‫Secure Source Manager תומך בסוגים הבאים של דיאגרמות Mermaid:

  • תרשימי זרימה: graph או flowchart (תמיכה ב-TD, ‏ TB, ‏ LR, ‏ BT, ‏ RL)
  • דיאגרמות רצף: sequenceDiagram
  • דיאגרמות של מחלקות: classDiagram
  • דיאגרמות של קשרים בין ישויות: erDiagram
  • דיאגרמות מצבים: stateDiagram או stateDiagram-v2
  • תרשימי XY: xychart-beta או xychart

התנהגות רינדור ומגבלות

  • רינדור סטטי: הדיאגרמות עוברות רינדור כתמונות סטטיות. תכונות אינטראקטיביות (כמו click בקשות להחזרת שיחה וטיפים) וסקריפטים חיצוניים מושבתים מטעמי אבטחה.
  • התאמת העיצוב: הדיאגרמות מותאמות אוטומטית לעיצובים בהירים וכהים.
  • נגישות: תרשימים שעברו עיבוד כוללים טקסט חלופי שמכיל את קוד המקור של התרשים, כדי שקוראי מסך יוכלו להקריא אותו.
  • סוגי דיאגרמות שלא נתמכים: סוגי דיאגרמות שלא נתמכים מציגים הודעת שגיאה ולא מעובדים. הם כוללים תרשימי גאנט, מפות חשיבה, תרשימי עוגה, Gitgraph, מסע משתמש, דרישות, C4, ציר זמן, סנקיי ודיאגרמות בלוקים. אם סוגי דיאגרמות לא נתמכים, יש לרנדר את הדיאגרמה באופן מקומי לתמונה (PNG או SVG) ולהטמיע אותה באמצעות תחביר תמונה רגיל של Markdown.

המאמרים הבאים