Ako integrovať GitHub s Slack pomocou Slack API

Integrácia GitHubu so Slackom vám pomôže zefektívniť komunikáciu vášho tímu informovaním o udalostiach repozitára v reálnom čase. Táto integrácia pomáha efektívnejšie spolupracovať, diskutovať o zmenách v kontexte kódovej základne a rýchlo riešiť akékoľvek obavy, ktoré môžu vzniknúť počas vývoja.

Navyše, integrácia GitHubu s Slack vám umožňuje prispôsobiť upozornenia tak, aby vyhovovali jedinečnému pracovnému postupu vášho tímu. To minimalizuje rozptýlenie a zameriava sa na to, na čom skutočne záleží. Tento prispôsobený prístup ku komunikácii umožňuje vášmu tímu prijímať informované rozhodnutia a prijímať včasné opatrenia, čím sa zabezpečí výstup najvyššej kvality.

Krok 1: Vytvorte novú aplikáciu Slack

Ak chcete pokračovať, mali by ste sa cítiť pohodlne pomocou platformy Slack. Mali by ste poznať aj GitHub.

Prvým krokom integrácie je vytvorenie novej aplikácie Slack. Táto aplikácia bude zodpovedná za odosielanie správ na vybranom kanáli Slack, keď dôjde k udalosti úložiska. Ak chcete vytvoriť novú aplikáciu, prejdite na

Slack web a prihláste sa do svojho účtu. Potom vytvorte nový pracovný priestor. Tento pracovný priestor použijete na otestovanie aplikácie pred jej inštaláciou do pracovného priestoru vášho tímu.

Prejdite na Web Slack API na novej karte prehliadača.

Kliknite na Vaše aplikácie tlačidlo. Na stránke, ktorá sa zobrazí, kliknite na Vytvoriť novú aplikáciu tlačidlo.

Vyberte možnosť vytvorenia aplikácie od začiatku. Potom pomenujte aplikáciu a vyberte pracovný priestor, do ktorého ju chcete nainštalovať.

Klikni na Vytvoriť aplikáciu tlačidlo. Táto akcia vytvorí vašu novú aplikáciu Slack a presmeruje vás na jej informačný panel.

Krok 2: Nastavte Slack Incoming Webhook

Slack Incoming Webhook vám umožňuje posielať správy z externých zdrojov do vášho pracovného priestoru Slack. Ak chcete nastaviť webhook, vyberte Prichádzajúce webhooky vlastnosť. Uistite sa, že ste zapli Aktivujte prichádzajúce webhooky tlačidlo.

Prejdite nadol na Webové adresy webhooku pre váš pracovný priestor oddiele. Klikni na Pridajte nový webhook do pracovného priestoru tlačidlo.

Slack vás požiada, aby ste si vybrali kanál, v ktorom bude vaša aplikácia uverejňovať správy. Vyberte kanál a kliknite na Povoliť tlačidlo.

Týmto pridáte svoju aplikáciu do vybratého kanála. Vráťte sa do Webové adresy webhooku pre váš pracovný priestor oddiele. Skopírujte vygenerované Webová adresa webhooku. Toto je adresa URL, na ktorú bude GitHub odosielať upozornenia na udalosti úložiska.

Teraz ste skončili s konfiguráciou strany Slack.

Krok 3: Nakonfigurujte GitHub Repo

Prejdite na Webová stránka GitHub a prihláste sa do svojho účtu. Prejdite do úložiska, z ktorého chcete dostávať upozornenia na udalosti. Môžete tiež vytvoriť nové úložisko. Klikni na Akcie pod názvom úložiska.

Potom kliknite na sami si nastavte pracovný postup odkaz. Ďalšia stránka, ktorá sa zobrazí, vyžaduje, aby ste vytvorili súbor YAML v adresári pracovných postupov GitHub. Tento súbor definuje pracovný postup akcií GitHub zodpovedný za odosielanie upozornení do vášho pracovného priestoru Slack.

YAML kód napíšete v integrovanom editore. Tento kód integruje GitHub so Slackom odosielaním upozornení na kanál Slack, keď sa v úložisku vyskytnú konkrétne udalosti.

Úplný zdrojový kód použitý v tomto článku je dostupný v a úložisko GitHub.

Krok 4: Napíšte YAML kód na integráciu GitHubu s Slack

Pomenujte svoj pracovný postup. Neváhajte a vyberte si meno podľa seba.

názov:SlackOznámenie

Zadajte udalosti, ktoré spustia pracovný tok. Tu si vyberiete udalosti, o ktorých chcete, aby bol váš tím informovaný. Pridajte alebo odstráňte udalosti, aby vyhovovali vašim požiadavkám.

na:
TAM:
pull_request:
problémy:
typy:
-otvorené
-ZATVORENÉ
-znovu otvorený
-upravené
-vymazané
-pripnuté
-odopnuté
-pridelených
-nepriradený
-označené
-neoznačené
-míľnikom
-demilestoned
issue_comment:
typy:[vytvorené,upravené,odstránené]
vytvoriť:
vymazať:

Nakonfigurujte svoju úlohu a vyberte si virtuálne prostredie, v ktorom sa bude spúšťať. notify_slack je názov práce. Môžete si ho zmeniť podľa seba.

pracovné miesta:
notify_slack:
nájazdy:ubuntu-najnovšie

Nastavte krok, ktorý bude zodpovedný za odoslanie upozornenia do Slacku.

kroky:
-názov:OdoslaťSlackoznámenie

Definujte premennú prostredia s názvom SLACK_WEBHOOK_URL. Uloží adresu URL webhooku Slack. Neskôr pridáte URL do tajomstiev úložiska GitHub.

env:
SLACK_WEBHOOK_URL:${{tajomstvá. SLACK_WEBHOOK_URL}}

Nakonfigurujte akčnosť Akcia GitHub. Čo je akcia tretej strany, ktorá spracováva základnú logiku interakcie s rozhraním Slack API. Umožňuje vám sústrediť sa na konfiguráciu správ a udalostí, ktoré spúšťajú upozornenia. Vďaka tomu je proces odosielania upozornení na Slack oveľa jednoduchší.

používa:8398a7/action-slack@v3

Tento kód používa 8398a7/action-slack@v3akcie.

Nakonfigurujte 8398a7/action-slack@v3 akcia s vlastnými parametrami. The postavenie parameter nastavuje stav správy na zvykom. Umožní vám definovať obsah správy Slack pomocou vlastného užitočného zaťaženia. The poliach parameter uvádza polia, ktoré sa majú zahrnúť do správy Slack.

s:
postavenie:zvykom
polia:repo, odovzdanie, udalosť, akcia, pracovný postup, ref, URL

Vytvor custom_payload ktorá prispôsobí vzhľad správy Slack tak, aby vyhovovala vašim preferenciám.

custom_payload:|
{
"prílohy":[
{
"farba":"${{ job.status }}",
"titul":>-
${{github.herec}}${{github.event.pull_request&&github.event.pull_request.merged==pravda&&„zlúčil žiadosť o stiahnutie“||github.event.pull_request&&'opened a pull request'||github.event_name=='TAM'&&'presadil nové zmeny'||github.event_name=='vytvoriť'&&'vytvorili novú vetvu alebo značku'||github.event_name=='delete'&&'odstránená vetva alebo značka'||github.event_name=='problémy'&&github.event.action||„spustil udalosť“}},
"text":>-
:tada:Podrobnosti o udalosti:

-Úložisko:${{github.repository}}
-Pobočka:${{github.ref}}
-Správa:${{github.event_name=='TAM'&&github.event.head_commit.message||github.event_name=='problémy'&&github.event.issue.title||github.event_name=='pull_request'&&github.event.pull_request.title||''}}
-:globe_with_meridians:odkaz:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Môžete sa odvolať na 8398a7/action-slack@v3 prípad vlastného použitia nájsť všetky podporované prispôsobenia. Potvrdením súboru YAML vytvorte nový pracovný postup.

Posledným krokom integrácie GitHubu so Slackom je pridanie nového tajomstva úložiska. Tajomstvom v tomto prípade je Slack webhook URL skopírovali ste zo Slacku. Udržujte túto webovú adresu v tajnosti, pretože ktokoľvek, kto k nej má prístup, môže odosielať správy do vášho pracovného priestoru.

Prejdite do nastavení úložiska. Klikni na tajomstvá a premenné pod bezpečnosť vlastnosť. Vyberte Akcie možnosť.

Kliknite na Nové tajomstvo úložiska. Pridajte názov tajenky ako SLACK_WEBHOOK_URL. Potom prilepte Slack URL do tajného poľa. Nakoniec kliknite na Pridať tajné tlačidlo na uloženie nového tajomstva.

Teraz ste dokončili integráciu GitHubu so Slackom. Vždy, keď sa vo vašom úložisku stane udalosť, vo vašom kanáli sa zobrazí správa. Skúste vytvorenie novej požiadavky na stiahnutie. Toto spustí udalosť push.

Snímka obrazovky nižšie zobrazuje vzorové správy na Slacku zobrazujúce udalosti, ktoré sa odohrali v úložisku.

Obsah správy môžete prispôsobiť tak, aby zahŕňal ďalšie polia, ktoré možno považujete za potrebné.

Zlepšite svoju produktivitu pomocou integrácií Slack

GitHub nie je jedinou integráciou Slack, ktorú môžete pridať do svojho pracovného priestoru. Existuje množstvo integrácií, ktoré môžete použiť na zlepšenie produktivity vášho tímu a zlepšenie ich komunikácie. Oboznámenie sa s týmito integráciami vám pomôže zefektívniť pracovný postup vášho tímu a udržať všetkých na rovnakej stránke.