Kako integrirati GitHub s Slack z API-jem Slack

Integracija GitHub s Slackom vam bo pomagala poenostaviti komunikacijo vaše ekipe, tako da jih boste obveščali o dogodkih v repozitoriju v realnem času. Ta integracija pomaga učinkoviteje sodelovati, razpravljati o spremembah v kontekstu baze kode in hitro obravnavati morebitne pomisleke, ki se lahko pojavijo med razvojem.

Poleg tega vam integracija GitHub s Slackom omogoča prilagajanje obvestil tako, da ustrezajo edinstvenemu delovnemu toku vaše ekipe. To zmanjša motnje in se osredotoči na tisto, kar je resnično pomembno. Ta prilagojen pristop k komunikaciji vaši ekipi omogoča sprejemanje premišljenih odločitev in pravočasno ukrepanje, kar zagotavlja najvišjo kakovost rezultatov.

1. korak: Ustvarite novo aplikacijo Slack

Če želite slediti, se morate počutiti udobno z uporabo platforme Slack. Poznati morate tudi GitHub.

Prvi korak integracije je ustvarjanje nove aplikacije Slack. Ta aplikacija bo odgovorna za objavo sporočil na izbranem kanalu Slack, ko pride do dogodka v repozitoriju. Če želite ustvariti novo aplikacijo, se pomaknite do

Slack spletno mesto in se prijavite v svoj račun. Nato ustvarite nov delovni prostor. Ta delovni prostor boste uporabili za testiranje svoje aplikacije, preden jo namestite v delovni prostor vaše ekipe.

Pomaknite se do Spletno mesto Slack API v novem zavihku brskalnika.

Kliknite na Vaše aplikacije gumb. Na strani, ki se prikaže, kliknite na Ustvari novo aplikacijo gumb.

Izberite možnost za ustvarjanje aplikacije iz nič. Nato poimenujte svojo aplikacijo in izberite delovni prostor, v katerega jo želite namestiti.

Kliknite na Ustvari aplikacijo gumb. S tem dejanjem boste ustvarili vašo novo aplikacijo Slack in vas preusmerili na njeno nadzorno ploščo.

2. korak: Nastavite Slack Incoming Webhook

Slack Incoming Webhook vam omogoča pošiljanje sporočil iz zunanjih virov v vaš delovni prostor Slack. Če želite nastaviti webhook, izberite Dohodni Webhooki funkcija. Prepričajte se, da ste vklopili Aktivirajte dohodne spletne trnke gumb.

Pomaknite se navzdol do URL-ji Webhook za vaš delovni prostor razdelek. Kliknite na Dodajte nov Webhook v delovni prostor gumb.

Slack vas bo pozval, da izberete kanal, v katerem bo vaša aplikacija objavljala sporočila. Izberite kanal in kliknite na Dovoli gumb.

To bo vašo aplikacijo dodalo v izbrani kanal. Pojdi nazaj na URL-ji Webhook za vaš delovni prostor razdelek. Kopirajte ustvarjeno Webhook URL. To je URL, na katerega bo GitHub pošiljal obvestila o dogodkih skladišča.

Končali ste s konfiguracijo strani Slack.

3. korak: Konfigurirajte GitHub Repo

Pomaknite se do Spletno mesto GitHub in se prijavite v svoj račun. Pojdite v repozitorij, iz katerega želite prejemati obvestila o dogodkih. Lahko tudi ustvarite novo skladišče. Kliknite na Dejanja pod imenom repozitorija.

Nato kliknite na sami nastavite potek dela povezava. Na naslednji strani, ki se prikaže, morate ustvariti datoteko YAML v imeniku delovnih tokov GitHub. Ta datoteka definira potek dela GitHub Actions, ki je odgovoren za pošiljanje obvestil v vaš delovni prostor Slack.

Kodo YAML boste napisali v integriranem urejevalniku. Ta koda bo integrirala GitHub s Slackom s pošiljanjem obvestil na kanal Slack, ko pride do določenih dogodkov v repozitoriju.

Celotna izvorna koda, uporabljena v tem članku, je na voljo v a Repozitorij GitHub.

4. korak: Napišite kodo YAML za integracijo GitHub s Slackom

Poimenujte potek dela. Prosto izberite ime po svojih željah.

ime:OhlapnostObvestilo

Določite dogodke, ki bodo sprožili potek dela. Tukaj izberete dogodke, o katerih želite, da je vaša ekipa obveščena. Dodajte ali odstranite dogodke, da ustrezajo vašim zahtevam.

na:
potisni:
pull_request:
vprašanja:
vrste:
-odprli
-zaprto
-ponovno odprta
-urejeno
-izbrisano
-pripeto
-odpeto
-dodeljena
-nedodeljen
-označeno
-neoznačeno
-mejnik
-demilestoneed
problem_komentar:
vrste:[ustvarjeno,urejeno,izbrisano]
ustvariti:
izbriši:

Konfigurirajte svoje opravilo in izberite virtualno okolje, v katerem se bo izvajalo. notify_slack je ime delovnega mesta. Lahko ga spremenite po svojih željah.

službe:
notify_slack:
nalet:ubuntu-najnovejša

Nastavite korak, ki bo odgovoren za pošiljanje obvestila Slacku.

koraki:
-ime:PošljiOhlapnostobvestilo

Definirajte spremenljivko okolja z imenom SLACK_WEBHOOK_URL. Shranil bo URL Slack webhook. Pozneje boste URL dodali skrivnostim repozitorija GitHub.

env:
SLACK_WEBHOOK_URL:${{skrivnosti. SLACK_WEBHOOK_URL}}

Konfigurirajte akcija-slack Dejanje GitHub. Kar je dejanje tretje osebe, ki obravnava temeljno logiko interakcije z API-jem Slack. Omogoča vam, da se osredotočite na konfiguracijo sporočil in dogodkov, ki sprožijo obvestila. Zaradi tega je postopek pošiljanja obvestil Slacku veliko lažji.

uporablja:8398a7/action-slack@v3

Ta koda uporablja 8398a7/action-slack@v3ukrepanje.

Konfigurirajte 8398a7/action-slack@v3 dejanje s parametri po meri. The stanje parameter nastavi status sporočila na po meri. Omogočil vam bo definiranje vsebine sporočila Slack z uporabo koristnega tovora po meri. The polja parameter navaja polja, ki jih je treba vključiti v sporočilo Slack.

z:
stanje:po meri
polja:repo, potrditev, dogodek, dejanje, potek dela, sklic, URL

Ustvariti obremenitev po meri ki bo prilagodil videz sporočila Slack vašim željam.

obremenitev po meri:|
{
"priponke":[
{
"barva":"${{ job.status }}",
"naslov":>-
${{github.actor}}${{github.event.pull_request&&github.event.pull_request.merged==prav&&'združil zahtevo za vlečenje'||github.event.pull_request&&'odprl zahtevo za vlečenje'||github.ime_dogodka=='push'&&'potisnil nove spremembe'||github.ime_dogodka=='ustvari'&&'ustvaril novo vejo ali oznako'||github.ime_dogodka=='izbriši'&&'izbrisal vejo ali oznako'||github.ime_dogodka=='težave'&&github.event.action||'sprožil dogodek'}},
"besedilo":>-
:tada:Podrobnosti dogodka:

-Repozitorij:${{github.repository}}
-podružnica:${{github.ref}}
-Sporočilo:${{github.ime_dogodka=='push'&&github.event.head_commit.message||github.ime_dogodka=='težave'&&github.event.issue.title||github.ime_dogodka=='pull_request'&&github.event.pull_request.title||''}}
-:globus_z_meridiani:Povezava:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Lahko se sklicujete na 8398a7/action-slack@v3 primer uporabe po meri da poiščete vse podprte prilagoditve. Potrdite datoteko YAML, da ustvarite nov potek dela.

Zadnji korak pri integraciji GitHub s Slackom je dodajanje nove skrivnosti repozitorija. Skrivnost v tem primeru je URL Slack Webhook kopirali ste iz Slacka. Ta URL naj bo tajen, saj lahko vsak, ki ima dostop do njega, pošilja sporočila v vaš delovni prostor.

Pomaknite se do nastavitev svojega skladišča. Kliknite na skrivnosti in spremenljivke pod varnost funkcija. Izberite Dejanja možnost.

Kliknite na Nova skrivnost skladišča. Dodajte ime skrivnosti kot SLACK_WEBHOOK_URL. Nato prilepite Slack URL v Skrivno polje. Na koncu kliknite na Dodaj skrivnost gumb za shranjevanje nove skrivnosti.

Zdaj ste končali integracijo GitHub s Slackom. Vsakič, ko se v vašem repozitoriju zgodi dogodek, bo v vašem kanalu prikazano sporočilo. poskusite ustvarjanje nove zahteve za vlečenje. To bo sprožilo potisni dogodek.

Spodnji posnetek zaslona prikazuje vzorčna sporočila na Slacku, ki prikazujejo dogodke, ki so se zgodili v skladišču.

Koristno vsebino sporočila lahko prilagodite tako, da vključuje druga polja, ki se vam morda zdijo potrebna.

Izboljšajte svojo produktivnost z integracijami Slack

GitHub ni edina integracija Slack, ki jo lahko dodate v svoj delovni prostor. Obstajajo številne integracije, s katerimi lahko izboljšate produktivnost svoje ekipe in izboljšate njihovo komunikacijo. Seznanitev s temi integracijami vam bo pomagala poenostaviti potek dela vaše ekipe in ohraniti vse na isti strani.