תיעוד

GitHub

מדידת התפוקה של צוות פיתוח (commits, PRs, סקירות) ומצב ה-CI ב-GitHub Actions מתוך pipeline.

האינטגרציה GitHub מעניקה ל-pipelines שלכם קריאה של פעילות הפיתוח: commits, pull requests, ביקורות, והרצות GitHub Actions — לפי מאגר ולפי מפתח. היא לקריאה בלבד: דבר אינו נכתב במאגרים שלכם.

מה אפשר לעשות עם זה

  • דוח ייצור צוותי — מי סיפק מה בתקופה: commits, שורות שנוספו / נמחקו, PR שנפתחו ומוזגו, מספר ביקורות.
  • בריאות ה-CI — מספר הרצות GitHub Actions שהצליחו, נכשלו ונמצאות בביצוע, לפי מאגר.
  • להזין סוכן — סוכן שמסכם את השבוע הטכני (ראו תרחישי שימוש → CTO IA).

חיבור

ב-הגדרות → שירותים → GitHub, לשונית חשבונות, שתי שיטות:

  1. התחברות עם GitHub — OAuth דרך האפליקציה של הפלטפורמה (כאשר המפעיל הגדיר אותה), ואז בחירת המאגרים למעקב. אין token להעתיק.
  2. הדבקת token (BYO) — token גישה של GitHub לקריאה (רצוי fine-grained PAT מוגבל למאגרים הרלוונטיים), רשימת המאגרים למעקב (owner/repo) ועבור GitHub Enterprise, בסיס API. ה-token מאוחסן בצד השרת ולעולם אינו מוצג שוב.

הצומת github_report

הצומת github_report מאחזר את הפעילות בחלון זמן (24h, 7d או 30d) ומפרסם אותה להקשר: פילוח לפי מפתח (by_developer) ולפי מאגר (by_repo), יומן commits ‏(commit_log), סיכומים, תקציר CI ‏(ci), ורשימת המאגרים שלא ניתן היה לקרוא (unreadable_repos). סוכן בהמשך הזרם הופך אותה לדוח קריא.

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

Tools של סוכן (קריאה): github.report, github.list_commits, github.list_pull_requests.

שיטות עבודה מומלצות

  • העדיפו token ייעודי לאינטגרציה על פני token אישי משותף.
  • צמצמו את ההרשאות למינימום ההכרחי (קריאת מאגרים, pull requests, פעולות).
  • שלבו עם הערוץ תזמון לדוח מחזורי (לדוגמה כל ערב בשעה 18:00).