כיצד לשלב GitHub עם Slack באמצעות Slack API

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

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

שלב 1: צור אפליקציית Slack חדשה

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

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

נווט אל אתר Slack API בכרטיסיית דפדפן חדשה.

לחץ על האפליקציות שלך לַחְצָן. בעמוד שמופיע, לחץ על צור אפליקציה חדשה לַחְצָן.

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

הקלק על ה צור אפליקציה לַחְצָן. פעולה זו תיצור את אפליקציית Slack החדשה שלך ותפנה אותך ללוח המחוונים שלה.

שלב 2: הגדר Webhook Incoming Slack

A Slack Incoming Webhook מאפשר לך לשלוח הודעות ממקורות חיצוניים לתוך סביבת העבודה Slack שלך. כדי להגדיר את ה-webhook, בחר את Webhooks נכנסות תכונה. ודא שאתה מפעיל את הפעל Webhooks נכנסות לַחְצָן.

גלול מטה אל Webhook כתובות אתרים עבור סביבת העבודה שלך סָעִיף. הקלק על ה הוסף Webhook חדש לסביבת העבודה לַחְצָן.

Slack יבקש ממך לבחור את הערוץ שבו האפליקציה שלך תפרסם הודעות. בחר את הערוץ ולחץ על להתיר לַחְצָן.

פעולה זו תוסיף את האפליקציה שלך לערוץ שנבחר. חזור אל Webhook כתובות אתרים עבור סביבת העבודה שלך סָעִיף. העתק את שנוצר URL של Webhook. זוהי כתובת האתר שאליה GitHub ישלח את ההתראות על אירועי המאגר.

כעת סיימת להגדיר את הצד Slack.

שלב 3: הגדר את GitHub Repo

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

לאחר מכן לחץ על הגדר זרימת עבודה בעצמך קישור. העמוד הבא שיופיע מחייב אותך ליצור קובץ YAML בספריית זרימות העבודה של GitHub. קובץ זה מגדיר את זרימת העבודה של GitHub Actions האחראית על שליחת הודעות לסביבת העבודה של Slack.

אתה תכתוב את קוד YAML בעורך המשולב. קוד זה ישלב את GitHub עם Slack על ידי שליחת הודעות לערוץ Slack כאשר מתרחשים אירועים ספציפיים במאגר.

קוד המקור המלא המשמש במאמר זה זמין ב-a מאגר GitHub.

שלב 4: כתוב את קוד YAML לשילוב GitHub עם Slack

תן שם לזרימת העבודה שלך. אל תהסס לבחור את השם לטעמך.

שֵׁם:רָפוּיהוֹדָעָה

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

עַל:
לִדחוֹף:
pull_request:
נושאים:
סוגים:
-נפתח
-סָגוּר
-נפתח מחדש
-עָרוּך
-נמחק
-מוצמד
-ביטול ההצמדה
-שהוקצה
-לא הוקצה
-מסומן
-ללא תווית
-אבני דרך
-סגור אבן
issue_comment:
סוגים:[נוצר,עָרוּך,נמחק]
לִיצוֹר:
לִמְחוֹק:

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

מקומות תעסוקה:
notify_slack:
ריצות:אובונטו-האחרון

הגדר שלב שיהיה אחראי על שליחת התראה ל-Slack.

שלבים:
-שֵׁם:לִשְׁלוֹחַרָפוּיהוֹדָעָה

הגדר משתנה סביבה בשם SLACK_WEBHOOK_URL. זה יאחסן את כתובת האתר של Slack webhook. מאוחר יותר תוסיף את כתובת האתר לסודות המאגר של GitHub.

env:
SLACK_WEBHOOK_URL:${{סודות. SLACK_WEBHOOK_URL}}

הגדר את רפיון פעולה פעולה של GitHub. שזו פעולה של צד שלישי שמטפלת בהיגיון הבסיסי של אינטראקציה עם ה-Slack API. זה מאפשר לך להתמקד בהגדרת ההודעות והאירועים שמפעילים את ההתראות. זה הופך את תהליך שליחת ההתראות ל-Slack להרבה יותר קל.

משתמש:8398a7/action-slack@v3

קוד זה משתמש ב- 8398a7/action-slack@v3פעולה.

הגדר את 8398a7/action-slack@v3 פעולה עם פרמטרים מותאמים אישית. ה סטָטוּס פרמטר מגדיר את מצב ההודעה ל המותאם אישית. זה יאפשר לך להגדיר את התוכן של הודעת Slack באמצעות מטען מותאם אישית. ה שדות פרמטר מפרט את השדות שיש לכלול בהודעת Slack.

עם:
סטָטוּס:המותאם אישית
שדות:repo, commit, event, action, workflow, ref, URL

ליצור מטען_מותאם אישית שיתאים אישית את המראה של הודעת Slack כך שתתאים להעדפותיך.

custom_payload:|
{
"קבצים מצורפים":[
{
"צֶבַע":"${{ מצב עבודה }}",
"כותרת":>-
${{github.actor}}${{github.event.pull_request&&github.event.pull_request.merged==נָכוֹן&&'מזג בקשת משיכה'||github.event.pull_request&&'פתח בקשת משיכה'||github.event_name=='לִדחוֹף'&&'דחף שינויים חדשים'||github.event_name=='לִיצוֹר'&&'יוצר סניף או תג חדש'||github.event_name=='לִמְחוֹק'&&'מחק ענף או תג'||github.event_name=='נושאים'&&github.event.action||'הפעיל אירוע'}},
"טֶקסט":>-
:טאדה:פרטי האירוע:

-מאגר:${{github.repository}}
-ענף:${{github.ref}}
-הוֹדָעָה:${{github.event_name=='לִדחוֹף'&&github.event.head_commit.message||github.event_name=='נושאים'&&github.event.issue.title||github.event_name=='pull_request'&&github.event.pull_request.title||''}}
-:globe_with_meridians:קישור:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

אתה יכול להתייחס ל 8398a7/action-slack@v3 מקרה שימוש מותאם אישית כדי למצוא את כל ההתאמות האישיות הנתמכות. הגדר את קובץ YAML כדי ליצור את זרימת העבודה החדשה.

השלב האחרון של שילוב GitHub עם Slack הוא הוספת סוד מאגר חדש. הסוד במקרה הזה הוא URL Slack Webhook העתקת מ-Slack. שמור את כתובת האתר הזו בסוד מכיוון שכל מי שיש לו גישה אליה יכול לשלוח הודעות לסביבת העבודה שלך.

נווט אל הגדרות המאגר שלך. הקלק על ה סודות ומשתנים תחת בִּטָחוֹן תכונה. בחר את פעולות אוֹפְּצִיָה.

לחץ על סוד מאגר חדש. הוסף את שם הסוד בשם SLACK_WEBHOOK_URL. לאחר מכן הדבק את כתובת URL רפויה לתוך שדה הסוד. לבסוף, לחץ על הוסף סוד לחצן כדי לשמור את הסוד החדש.

כעת סיימת לשלב את GitHub עם Slack. בכל פעם שמתרחש אירוע במאגר שלך תוצג הודעה בערוץ שלך. לְנַסוֹת יצירת בקשת משיכה חדשה. זה יפעיל אירוע דחיפה.

צילום המסך למטה מציג הודעות לדוגמה ב-Slack המציגות אירועים שהתרחשו במאגר.

אתה יכול להתאים אישית את מטען ההודעה כך שיכלול שדות אחרים שאתה עשוי למצוא צורך.

שפר את הפרודוקטיביות שלך עם אינטגרציות רפויות

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