Πώς να ενσωματώσετε το GitHub με το Slack χρησιμοποιώντας το Slack API

Η ενσωμάτωση του GitHub με το Slack θα σας βοηθήσει να βελτιστοποιήσετε την επικοινωνία της ομάδας σας ενημερώνοντάς την για συμβάντα αποθετηρίου σε πραγματικό χρόνο. Αυτή η ενοποίηση βοηθά στην αποτελεσματικότερη συνεργασία, στη συζήτηση αλλαγών στο πλαίσιο της βάσης κώδικα και στην γρήγορη αντιμετώπιση τυχόν ανησυχιών που μπορεί να προκύψουν κατά την ανάπτυξη.

Επιπλέον, η ενσωμάτωση του GitHub με το Slack σάς επιτρέπει να προσαρμόσετε τις ειδοποιήσεις ώστε να ταιριάζουν στη μοναδική ροή εργασίας της ομάδας σας. Αυτό ελαχιστοποιεί τους περισπασμούς και εστιάζει σε αυτό που πραγματικά έχει σημασία. Αυτή η προσαρμοσμένη προσέγγιση στην επικοινωνία εξουσιοδοτεί την ομάδα σας να λαμβάνει τεκμηριωμένες αποφάσεις και να λαμβάνει έγκαιρα μέτρα, διασφαλίζοντας την υψηλότερη ποιότητα παραγωγής.

Βήμα 1: Δημιουργήστε μια νέα εφαρμογή Slack

Για να συνεχίσετε, θα πρέπει να είστε άνετα χρησιμοποιώντας την πλατφόρμα Slack. Θα πρέπει επίσης να είστε εξοικειωμένοι με το GitHub.

Το πρώτο βήμα της ενοποίησης είναι η δημιουργία μιας νέας εφαρμογής Slack. Αυτή η εφαρμογή θα είναι υπεύθυνη για τη δημοσίευση μηνυμάτων στο επιλεγμένο κανάλι Slack όταν συμβεί ένα συμβάν αποθήκης. Για να δημιουργήσετε μια νέα εφαρμογή, μεταβείτε στο Χαλαρή ιστοσελίδα και συνδεθείτε στον λογαριασμό σας. Στη συνέχεια, δημιουργήστε έναν νέο χώρο εργασίας. Θα χρησιμοποιήσετε αυτόν τον χώρο εργασίας για να δοκιμάσετε την εφαρμογή σας πριν την εγκαταστήσετε στον χώρο εργασίας της ομάδας σας.

Πλοηγηθείτε στο Ιστότοπος Slack API σε μια νέα καρτέλα προγράμματος περιήγησης.

Κάντε κλικ στο Οι εφαρμογές σας κουμπί. Στη σελίδα που εμφανίζεται, κάντε κλικ στο Δημιουργία νέας εφαρμογής κουμπί.

Επιλέξτε την επιλογή δημιουργίας της εφαρμογής από την αρχή. Στη συνέχεια, ονομάστε την εφαρμογή σας και επιλέξτε τον χώρο εργασίας στον οποίο θέλετε να την εγκαταστήσετε.

Κάνε κλικ στο Δημιουργία εφαρμογής κουμπί. Αυτή η ενέργεια θα δημιουργήσει τη νέα σας εφαρμογή Slack και θα σας ανακατευθύνει στον πίνακα ελέγχου της.

Βήμα 2: Ρυθμίστε ένα Slack Incoming Webhook

Ένα Slack Incoming Webhook σάς επιτρέπει να στέλνετε μηνύματα από εξωτερικές πηγές στον χώρο εργασίας σας Slack. Για να ρυθμίσετε το webhook, επιλέξτε το Εισερχόμενα Webhook χαρακτηριστικό. Βεβαιωθείτε ότι έχετε ενεργοποιήσει το Ενεργοποιήστε τα Εισερχόμενα Webhook κουμπί.

Κάντε κύλιση προς τα κάτω στο Διευθύνσεις URL Webhook για τον χώρο εργασίας σας Ενότητα. Κάνε κλικ στο Προσθήκη νέου Webhook στον χώρο εργασίας κουμπί.

Το Slack θα σας ζητήσει να επιλέξετε το κανάλι στο οποίο η εφαρμογή σας θα δημοσιεύει μηνύματα. Επιλέξτε το κανάλι και κάντε κλικ στο Επιτρέπω κουμπί.

Αυτό θα προσθέσει την εφαρμογή σας στο επιλεγμένο κανάλι. Επιστρέψτε στο Διευθύνσεις URL Webhook για τον χώρο εργασίας σας Ενότητα. Αντιγράψτε το δημιουργημένο URL webhook. Αυτή είναι η διεύθυνση URL στην οποία το GitHub θα στείλει τις ειδοποιήσεις συμβάντων του αποθετηρίου.

Τώρα ολοκληρώσατε τη διαμόρφωση της πλευράς Slack.

Βήμα 3: Διαμορφώστε το GitHub Repo

Πλοηγηθείτε στο Ιστοσελίδα GitHub και συνδεθείτε στον λογαριασμό σας. Μεταβείτε στο αποθετήριο από το οποίο θέλετε να λαμβάνετε τις ειδοποιήσεις συμβάντων. Μπορείτε επίσης να δημιουργήστε ένα νέο αποθετήριο. Κάνε κλικ στο Ενέργειες καρτέλα κάτω από το όνομα του αποθετηρίου.

Στη συνέχεια κάντε κλικ στο δημιουργήστε μόνοι σας μια ροή εργασίας Σύνδεσμος. Η επόμενη σελίδα που εμφανίζεται απαιτεί να δημιουργήσετε ένα αρχείο YAML στον κατάλογο ροών εργασίας GitHub. Αυτό το αρχείο ορίζει τη ροή εργασιών GitHub Actions που είναι υπεύθυνη για την αποστολή ειδοποιήσεων στον χώρο εργασίας σας Slack.

Θα γράψετε τον κώδικα YAML στον ενσωματωμένο επεξεργαστή. Αυτός ο κώδικας θα ενσωματώσει το GitHub με το Slack στέλνοντας ειδοποιήσεις σε ένα κανάλι Slack όταν συμβαίνουν συγκεκριμένα συμβάντα στο αποθετήριο.

Ο πλήρης πηγαίος κώδικας που χρησιμοποιείται σε αυτό το άρθρο είναι διαθέσιμος στο α Αποθετήριο GitHub.

Βήμα 4: Γράψτε τον κώδικα YAML για την ενσωμάτωση του GitHub με το Slack

Ονομάστε τη ροή εργασίας σας. Μη διστάσετε να επιλέξετε το όνομα της αρεσκείας σας.

όνομα:ΧαλαρότηταΓνωστοποίηση

Καθορίστε τα συμβάντα που θα ενεργοποιήσουν τη ροή εργασίας. Εδώ επιλέγετε τα συμβάντα για τα οποία θέλετε να ειδοποιείται η ομάδα σας. Προσθέστε ή αφαιρέστε τα συμβάντα για να ταιριάζουν στις απαιτήσεις σας.

επί:
Σπρώξτε:
pull_request:
θέματα:
τύποι:
-άνοιξε
-κλειστό
-άνοιξε ξανά
-επιμελήθηκε
-διαγράφηκε
-καρφιτσωμένο
-ξεκαρφιτσωμένο
-ανατεθεί
-αδιάθετο
-με την ένδειξη
-χωρίς ετικέτα
-ορόσημο
-αποκαθηλωμένος
issue_comment:
τύποι:[δημιουργήθηκε,επεξεργάστηκε,διαγράφηκε]
δημιουργώ:
διαγράφω:

Διαμορφώστε την εργασία σας και επιλέξτε το εικονικό περιβάλλον στο οποίο θα εκτελείται. notify_slack είναι το όνομα της δουλειάς. Μπορείτε να το αλλάξετε σύμφωνα με τις προτιμήσεις σας.

θέσεις εργασίας:
notify_slack:
τρέχει:ubuntu-πιο πρόσφατο

Ρυθμίστε ένα βήμα που θα είναι υπεύθυνο για την αποστολή ειδοποίησης στο Slack.

βήματα:
-όνομα:ΣτείλετεΧαλαρότηταΓνωστοποίηση

Ορίστε μια μεταβλητή περιβάλλοντος με όνομα SLACK_WEBHOOK_URL. Θα αποθηκεύσει τη διεύθυνση URL του Slack webhook. Αργότερα θα προσθέσετε τη διεύθυνση URL στα μυστικά του αποθετηρίου του 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, δέσμευση, συμβάν, ενέργεια, ροή εργασίας, αναφορά, διεύθυνση URL

Δημιουργώ ένα custom_payload που θα προσαρμόσει την εμφάνιση του μηνύματος Slack ώστε να ταιριάζει στις προτιμήσεις σας.

custom_payload:|
{
"συνημμένα":[
{
"χρώμα":"${{ job.status }}",
"τίτλος":>-
${{github.ηθοποιός}}${{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||«προκάλεσε ένα συμβάν»}},
"κείμενο":>-
:tada:Λεπτομέρειες εκδήλωσης:

-Αποθήκη:${{github.repository}}
-Κλαδί:${{github.αναφ}}
-Μήνυμα:${{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 Webhook αντιγράψατε από το Slack. Κρατήστε αυτήν τη διεύθυνση URL μυστική, καθώς οποιοσδήποτε έχει πρόσβαση σε αυτήν μπορεί να στείλει μηνύματα στον χώρο εργασίας σας.

Μεταβείτε στις ρυθμίσεις του αποθετηρίου σας. Κάνε κλικ στο μυστικά και μεταβλητές σύμφωνα με το ασφάλεια χαρακτηριστικό. Επίλεξε το Ενέργειες επιλογή.

Κάντε κλικ στο Νέο μυστικό αποθετηρίου. Προσθέστε το όνομα του μυστικού ως SLACK_WEBHOOK_URL. Στη συνέχεια επικολλήστε το Χαλαρή διεύθυνση URL στο μυστικό πεδίο. Τέλος, κάντε κλικ στο Προσθήκη μυστικού κουμπί για να αποθηκεύσετε το νέο μυστικό.

Έχετε πλέον ολοκληρώσει την ενσωμάτωση του GitHub με το Slack. Κάθε φορά που συμβαίνει ένα συμβάν στο αποθετήριο σας, θα εμφανίζεται ένα μήνυμα στο κανάλι σας. Δοκιμάστε δημιουργώντας ένα νέο αίτημα έλξης. Αυτό θα πυροδοτήσει ένα συμβάν push.

Το παρακάτω στιγμιότυπο οθόνης δείχνει δείγματα μηνυμάτων στο Slack που δείχνουν συμβάντα που έλαβαν χώρα σε ένα αποθετήριο.

Μπορείτε να προσαρμόσετε το ωφέλιμο φορτίο μηνυμάτων ώστε να περιλαμβάνει άλλα πεδία που μπορεί να θεωρήσετε απαραίτητα.

Βελτιώστε την παραγωγικότητά σας με ενσωματώσεις Slack

Το GitHub δεν είναι η μόνη ενσωμάτωση Slack που μπορείτε να προσθέσετε στον χώρο εργασίας σας. Υπάρχουν πολλές ενσωματώσεις που μπορείτε να χρησιμοποιήσετε για να βελτιώσετε την παραγωγικότητα της ομάδας σας και να βελτιώσετε την επικοινωνία τους. Η εξοικείωση με αυτές τις ενσωματώσεις θα σας βοηθήσει να βελτιστοποιήσετε τη ροή εργασιών της ομάδας σας και να κρατήσετε όλους στην ίδια σελίδα.