תיעוד

GitHub

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

GitHub מתחבר דרך Coroid GitHub App או דרך אסמכתא גישה אישית. ניתן להגדיר אותה ב הגדרות → חיבורים → בקרת קוד מקור.

אפליקציה או אסמכתא

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

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

GitHub Appאסמכתא גישה אישית
טווח הגישהלפי מאגר נתוניםכל מה שהמשתמש יכול לראות
נשאר פעיל גם אחרי עזיבת המתקיןכןלא
אירועי Webhookכןבדיקות תכופות
הקצאההאפליקציהבעל האסמכתא

התקנת האפליקציה

בחרו GitHub ב הגדרות → חיבורים → בקרת קוד מקור ועקבו אחר תהליך ההתקנה. GitHub תבקש לאילו מאגרי נתונים להעניק גישה; ניתן לשנות זאת מאוחר יותר בהגדרות של GitHub עצמה.

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

שימוש באסמכתא

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

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

בעיות של GitHub

אותו חיבור תומך ייבוא בעיות כעבודה. ראה ייבוא עבודה.

אירועים שנהפכים לעבודה

באמצעות האפליקציה, אוטומציית אירועים יכולה לשלוח pull request, בעיה חדשה או תגובה המזכירה את Coroid לתהליך הכשרה. ראה מפעילים ויעדים.

עבודה שהוכשרה מאירועים אלה מתחילה מעצמה רק כאשר למחבר יש גישת כתיבה, תחזוקה או ניהול לרפרוזיטוריון. ה־Coroid מבקש מ־GitHub עבור כל אירוע. עבור pull request, המחבר הוא האדם שפתח אותו, ולא זה שתייג או מיזג אותו. עבודה שמקורה באדם אחר נוצרת וממתינה שמישהו יתחיל אותה. תגובה המזכירה את Coroid נחשבת רק כאשר למחבר יש גישת כתיבה.

סקירת בקשות משיכה

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

מה ה־Coroid עושה ברפרוזיטוריון שלך?

  • קורא קוד כדי להבין ולשנות אותו
  • יוצר ענף לכל משימה
  • דוחף את אותו ענף ופותח בקשת משיכה של pull request מול ענף הבסיס שלך

הוא לעולם לא מבצע קומיט לענף המוגדר כברירת מחדל שלך או מבצע מיזוג מעצמו. מיזוג מתרחש רק כאשר אדם ממזג את ה־pull request ב־GitHub או לוחץ אישור ומיזוג ב־Coroid.

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

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