كيفية دمج GitHub مع Slack باستخدام Slack API

سيساعدك دمج GitHub مع Slack على تبسيط اتصالات فريقك من خلال إعلامهم بأحداث المستودعات في الوقت الفعلي. يساعد هذا التكامل على التعاون بشكل أكثر كفاءة ، ومناقشة التغييرات في سياق قاعدة التعليمات البرمجية ، ومعالجة أي مخاوف قد تنشأ أثناء التطوير بسرعة.

علاوة على ذلك ، يتيح لك دمج GitHub مع Slack تخصيص الإشعارات لتناسب سير العمل الفريد لفريقك. هذا يقلل من المشتتات ويركز على ما يهم حقًا. يمكّن هذا النهج المخصص للتواصل فريقك من اتخاذ قرارات مستنيرة واتخاذ الإجراءات في الوقت المناسب ، مما يضمن أعلى جودة للمخرجات.

الخطوة 1: إنشاء تطبيق Slack جديد

للمتابعة ، يجب أن تكون مرتاحًا باستخدام منصة Slack. يجب أن تكون أيضًا على دراية بـ GitHub.

تتمثل الخطوة الأولى في التكامل في إنشاء تطبيق Slack جديد. سيكون هذا التطبيق مسؤولاً عن نشر الرسائل على قناة Slack المحددة عند حدوث حدث المستودع. لإنشاء تطبيق جديد ، انتقل إلى موقع Slack وقم بتسجيل الدخول إلى حسابك. ثم قم بإنشاء مساحة عمل جديدة. ستستخدم مساحة العمل هذه لاختبار تطبيقك قبل تثبيته في مساحة عمل فريقك.

انتقل إلى موقع ويب Slack API في علامة تبويب المتصفح الجديدة.

انقر فوق تطبيقاتك زر. في الصفحة التي تظهر ، انقر فوق إنشاء تطبيق جديد زر.

اختر خيار إنشاء التطبيق من البداية. ثم قم بتسمية التطبيق الخاص بك واختر مساحة العمل التي تريد تثبيته عليها.

اضغط على إنشاء التطبيق زر. سيؤدي هذا الإجراء إلى إنشاء تطبيق Slack الجديد الخاص بك وإعادة توجيهك إلى لوحة التحكم الخاصة به.

الخطوة 2: إعداد خطاف الويب الوارد من Slack

يسمح لك Slack Incoming Webhook بإرسال رسائل من مصادر خارجية إلى مساحة عمل Slack الخاصة بك. لإعداد الخطاف التلقائي على الويب ، اختر ملف خطاطيف الويب الواردة ميزة. تأكد من تشغيل تنشيط Webhooks الواردة زر.

قم بالتمرير لأسفل إلى ملف عناوين URL للويب هوك لمساحة العمل الخاصة بك قسم. اضغط على إضافة خطاف ويب جديد إلى مساحة العمل زر.

سيطلب منك Slack اختيار القناة التي سينشر فيها تطبيقك الرسائل. اختر القناة وانقر على يسمح زر.

سيؤدي ذلك إلى إضافة تطبيقك إلى القناة المحددة. ارجع إلى عناوين URL للويب هوك لمساحة العمل الخاصة بك قسم. انسخ ملف عنوان URL للويب هوك. هذا هو عنوان URL الذي سيرسل GitHub إليه إشعارات حدث المستودع.

لقد انتهيت الآن من تكوين جانب Slack.

الخطوة 3: تكوين GitHub Repo

انتقل إلى موقع جيثب وقم بتسجيل الدخول إلى حسابك. انتقل إلى المستودع الذي تريد أن تتلقى إشعارات الأحداث منه. بامكانك ايضا إنشاء مستودع جديد. اضغط على أجراءات علامة التبويب تحت اسم المستودع.

ثم انقر فوق قم بإعداد سير العمل بنفسك وصلة. الصفحة التالية التي تظهر تتطلب منك إنشاء ملف YAML في دليل سير عمل GitHub. يحدد هذا الملف سير عمل GitHub Actions المسؤول عن إرسال الإشعارات إلى مساحة عمل Slack الخاصة بك.

سوف تكتب كود YAML في المحرر المدمج. سيقوم هذا الرمز بدمج GitHub مع Slack عن طريق إرسال إشعارات إلى قناة Slack عند حدوث أحداث معينة في المستودع.

شفرة المصدر الكاملة المستخدمة في هذه المقالة متاحة في ملف مستودع جيثب.

الخطوة 4: اكتب كود YAML لدمج GitHub مع Slack

قم بتسمية سير العمل الخاص بك. لا تتردد في اختيار الاسم الذي يعجبك.

اسم:تثاقلإشعار

حدد الأحداث التي ستطلق سير العمل. هذا هو المكان الذي تختار فيه الأحداث التي تريد أن يتم إعلام فريقك بها. أضف أو أزل الأحداث لتناسب متطلباتك.

على:
يدفع:
طلب سحب:
مشاكل:
الأنواع:
-افتتح
-مغلق
-أعيد فتحه
-تم تحريره
-تم الحذف
-مثبت
-غير مثبت
-مُكَلَّف
-غير معين
-المسمى
-غير مصنف
-ميلستونيد
-محطمة
المسألة_التعليق:
الأنواع:[مخلوق،تم تحريره ،تم الحذف]
يخلق:
يمسح:

قم بتكوين وظيفتك واختر البيئة الافتراضية التي ستعمل عليها. notify_slack هو اسم الوظيفة. يمكنك تغييره حسب رغبتك.

وظائف:
notify_slack:
يعمل على:ubuntu-الأحدث

قم بإعداد خطوة ستكون مسؤولة عن إرسال إشعار إلى Slack.

خطوات:
-اسم:يرسلتثاقلإشعار

تحديد اسم متغير بيئة SLACK_WEBHOOK_URL. سيتم تخزين عنوان URL لـ Slack webhook. ستضيف لاحقًا عنوان URL إلى أسرار مستودع GitHub.

env:
SLACK_WEBHOOK_URL:${{أسرار. SLACK_WEBHOOK_URL}}

قم بتكوين ملف العمل المتراخي جيثب أكشن. وهو إجراء من طرف ثالث يتعامل مع المنطق الأساسي للتفاعل مع Slack API. يسمح لك بالتركيز على تكوين الرسائل والأحداث التي تؤدي إلى تشغيل الإشعارات. هذا يجعل عملية إرسال الإشعارات إلى Slack أسهل بكثير.

الاستخدامات:8398a7 / عمل سلاك @ v3

يستخدم هذا الرمز الامتداد 8398a7 / عمل سلاك @ v3فعل.

قم بتكوين ملف 8398a7 / عمل سلاك @ v3 العمل مع المعلمات المخصصة. ال حالة المعلمة تعيّن حالة الرسالة إلى مخصص. سيسمح لك بتحديد محتوى رسالة Slack باستخدام حمولة مخصصة. ال مجالات تسرد المعلمة الحقول المطلوب تضمينها في رسالة Slack.

مع:
حالة:مخصص
مجالات:الريبو ، الالتزام ، الحدث ، الإجراء ، سير العمل ، المرجع ، URL

إنشاء custom_payload سيخصص مظهر رسالة Slack ليناسب تفضيلاتك.

custom_payload:|
{
"المرفقات":[
{
"لون":"${{job.status}}",
"عنوان":>-
${{جيثب}}${{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_name=='يدفع'&&github.event.head_commit.message||github.event_name=='مشاكل'&&github.event.issue.title||github.event_name=='طلب سحب'&&github.event.pull_request.title||''}}
-: غلوب_مع_مريديان:وصلة:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

يمكنك الرجوع إلى 8398a7 / action-slack @ v3 حالة الاستخدام المخصص للعثور على جميع التخصيصات المدعومة. قم بإلزام ملف YAML لإنشاء سير العمل الجديد.

تتمثل الخطوة الأخيرة لدمج GitHub مع Slack في إضافة سر مستودع جديد. السر في هذه الحالة هو Slack Webhook URL قمت بنسخها من Slack. حافظ على سرية عنوان URL هذا حيث يمكن لأي شخص لديه حق الوصول إليه إرسال رسائل إلى مساحة العمل الخاصة بك.

انتقل إلى إعدادات المستودع الخاص بك. اضغط على الأسرار والمتغيرات تحت حماية ميزة. حدد ملف أجراءات خيار.

انقر فوق سر المستودع الجديد. أضف اسم السر كـ SLACK_WEBHOOK_URL. ثم الصق ملف سلاك URL في المجال السري. أخيرًا ، انقر فوق أضف السر زر لحفظ السر الجديد.

لقد انتهيت الآن من دمج GitHub مع Slack. في كل مرة يقع فيها حدث ما في المستودع الخاص بك ، سيتم عرض رسالة في قناتك. يحاول إنشاء طلب سحب جديد. سيؤدي هذا إلى تشغيل حدث دفع.

تُظهر لقطة الشاشة أدناه نماذج من الرسائل على Slack تُظهر الأحداث التي وقعت في أحد المستودعات.

يمكنك تخصيص حمولة الرسالة لتضمين الحقول الأخرى التي قد تجدها ضرورية.

تحسين إنتاجيتك مع تكاملات Slack

GitHub ليس هو تكامل Slack الوحيد الذي يمكنك إضافته إلى مساحة العمل الخاصة بك. هناك العديد من عمليات الدمج التي يمكنك استخدامها لتحسين إنتاجية فريقك وتعزيز تواصلهم. سيساعدك التعرف على عمليات الدمج هذه على تبسيط سير عمل فريقك وإبقاء الجميع في نفس الصفحة.