Comment intégrer GitHub à Slack en utilisant l’API de Slack

L’intégration de GitHub avec Slack vous aidera à rationaliser la communication de votre équipe en l’informant des événements du dépôt en temps réel. Cette intégration permet de collaborer plus efficacement, de discuter des modifications dans le contexte de la base de code et de répondre rapidement à toute préoccupation pouvant survenir au cours du développement.

De plus, l’intégration de GitHub avec Slack vous permet de personnaliser les notifications en fonction du flux de travail unique de votre équipe. Cela permet de minimiser les distractions et de se concentrer sur ce qui compte vraiment. Cette approche personnalisée de la communication permet à votre équipe de prendre des décisions éclairées et des mesures opportunes, garantissant ainsi un résultat de la plus haute qualité.

Étape 1 : Créer une nouvelle application Slack

Pour suivre cette étape, vous devez être à l’aise avec la plateforme Slack. Vous devez également être familiarisé avec GitHub.

La première étape de l’intégration consiste à créer une nouvelle application Slack. Cette application sera chargée de poster des messages sur le canal Slack sélectionné lorsqu’un événement de dépôt se produit. Pour créer une nouvelle application, naviguez jusqu’à l’onglet site web de Slack et connectez-vous à votre compte. Créez ensuite un nouvel espace de travail. Vous utiliserez cet espace de travail pour tester votre application avant de l’installer dans l’espace de travail de votre équipe.

Naviguez jusqu’à l’espace de travail site web de l’API Slack dans un nouvel onglet du navigateur.

Cliquez sur Vos applications . Sur la page qui s’affiche, cliquez sur le bouton Créer une nouvelle application .

Choisissez l’option permettant de créer l’application à partir de zéro. Nommez ensuite votre application et choisissez l’espace de travail dans lequel vous souhaitez l’installer.

Cliquez sur le bouton Créer une application . Cette action créera votre nouvelle application Slack et vous redirigera vers son tableau de bord.

Étape 2 : Configurer un Webhook entrant Slack

Un crochet Web entrant Slack vous permet d’envoyer des messages provenant de sources externes dans votre espace de travail Slack. Pour configurer le webhook, choisissez l’option Crochets Web entrants (crochets Web entrants). Veillez à activer la fonction Activer les webhooks entrants pour activer les webhooks entrants.

Faites défiler vers le bas jusqu’au bouton URL du crochet Web pour votre espace de travail Cliquez sur l’URL Ajouter un nouveau Webhook à l’espace de travail .

Slack vous demandera de choisir le canal dans lequel votre application publiera des messages. Choisissez le canal et cliquez sur le bouton Autoriser et cliquez sur le bouton Autoriser

Ceci ajoutera votre application au canal sélectionné. Revenez au bouton URL des webhooks pour votre espace de travail de votre espace de travail. Copiez les générée. Il s’agit de l’URL à laquelle GitHub enverra les notifications d’événements du dépôt.

Vous avez maintenant fini de configurer le côté Slack.

Étape 3 : Configurer le dépôt GitHub

Naviguez jusqu’à la page site web de GitHub et connectez-vous à votre compte. Allez dans le référentiel dont vous souhaitez recevoir les notifications d’événements. Vous pouvez également créer un nouveau référentiel. Cliquez sur l’icône Actions sous le nom du référentiel.

Cliquez ensuite sur l’onglet configurer vous-même un flux de travail La page suivante qui s’affiche vous demande de créer un fichier YAML dans le répertoire GitHub workflows. Ce fichier définit le flux de travail GitHub Actions responsable de l’envoi de notifications à votre espace de travail Slack.

Vous écrirez le code YAML dans l’éditeur intégré. Ce code intégrera GitHub avec Slack en envoyant des notifications à un canal Slack lorsque des événements spécifiques se produisent dans le dépôt.

Le code source complet utilisé dans cet article est disponible dans un dépôt GitHub.

Étape 4 : Écrire le code YAML pour l’intégration de GitHub avec Slack

Donnez un nom à votre flux de travail. N’hésitez pas à choisir le nom de votre choix.

Spécifiez les événements qui déclencheront le flux de travail. C’est ici que vous choisissez les événements dont vous voulez que votre équipe soit informée. Ajoutez ou supprimez les événements en fonction de vos besoins.

Configurez votre job et choisissez l’environnement virtuel sur lequel il s’exécutera. notify_slack est le nom du job. Vous pouvez le modifier à votre guise.

Configurez une étape qui sera responsable de l’envoi d’une notification à Slack.

Définissez une variable d’environnement nommée SLACK_WEBHOOK_URL. Elle stockera l’URL du webhook de Slack. Vous ajouterez plus tard l’URL aux secrets du dépôt de GitHub.

Configurez le action-slack GitHub Action. Il s’agit d’une action tierce qui gère la logique sous-jacente de l’interaction avec l’API Slack. Elle vous permet de vous concentrer sur la configuration des messages et des événements qui déclenchent les notifications. Cela rend le processus d’envoi de notifications à Slack beaucoup plus facile.

Ce code utilise l’élément 8398a7/action-slack@v3 action.

Configurez l’action 8398a7/action-slack@v3 avec des paramètres personnalisés. L’action statut définit l’état du message à personnalisé. Il vous permettra de définir le contenu du message Slack à l’aide d’une charge utile personnalisée. Le paramètre champs énumère les champs à inclure dans le message Slack.

Créer un custom_payload qui personnalisera l’apparence du message Slack en fonction de vos préférences.

Vous pouvez vous référer à l’élément 8398a7/action-slack@v3 cas d’utilisation personnalisé pour connaître toutes les personnalisations prises en charge. Validez le fichier YAML pour créer le nouveau flux de travail.

La dernière étape de l’intégration de GitHub avec Slack consiste à ajouter un nouveau secret de dépôt. Dans ce cas, le secret est le fichier URL de Slack Webhook que vous avez copiée depuis Slack. Gardez cette URL secrète, car toute personne y ayant accès peut envoyer des messages à votre espace de travail.

Naviguez vers les paramètres de votre référentiel. Cliquez sur l’icône secrets et variables sous la rubrique sécurité . Sélectionnez l’option Actions l’option.

Cliquez sur Nouveau référentiel secret. Ajoutez le nom du secret comme SLACK_WEBHOOK_URL. Ensuite, collez le URL de Slack dans le champ Secret. Enfin, cliquez sur le champ Ajouter un secret pour enregistrer le nouveau secret.

Vous avez maintenant terminé l’intégration de GitHub avec Slack. Chaque fois qu’un événement se produit dans votre dépôt, un message sera affiché dans votre canal. Essayez de créer une nouvelle pull request. Cela déclenchera un événement push.

La capture d’écran ci-dessous montre des exemples de messages sur Slack montrant des événements qui ont eu lieu dans un dépôt.

Vous pouvez personnaliser la charge utile du message pour inclure d’autres champs que vous jugez nécessaires.

Améliorez votre productivité grâce aux intégrations Slack

GitHub n’est pas la seule intégration Slack que vous pouvez ajouter à votre espace de travail. Il existe de nombreuses intégrations que vous pouvez utiliser pour améliorer la productivité de votre équipe et renforcer leur communication. Se familiariser avec ces intégrations vous aidera à rationaliser le flux de travail de votre équipe et à faire en sorte que tout le monde soit sur la même longueur d’onde.

S’abonner à notre lettre d’information