Kaip integruoti „GitHub“ su „Slack“ naudojant „Slack“ API

„GitHub“ integravimas su „Slack“ padės supaprastinti komandos bendravimą, informuojant juos apie saugyklos įvykius realiuoju laiku. Ši integracija padeda efektyviau bendradarbiauti, aptarti pakeitimus kodo bazės kontekste ir greitai išspręsti bet kokias problemas, kurios gali kilti kuriant.

Be to, „GitHub“ integravimas su „Slack“ leidžia tinkinti pranešimus, kad jie atitiktų jūsų komandos unikalią darbo eigą. Tai sumažina blaškymąsi ir sutelkia dėmesį į tai, kas iš tikrųjų svarbu. Šis pritaikytas požiūris į komunikaciją įgalina jūsų komandą priimti pagrįstus sprendimus ir laiku imtis veiksmų, užtikrinant aukščiausios kokybės rezultatus.

1 veiksmas: sukurkite naują „Slack“ programą

Norėdami tai padaryti, turite jaustis patogiai naudojant Slack platformą. Taip pat turėtumėte būti susipažinę su „GitHub“.

Pirmasis integracijos žingsnis yra naujos „Slack“ programos kūrimas. Ši programa bus atsakinga už pranešimų paskelbimą pasirinktame „Slack“ kanale, kai įvyks saugyklos įvykis. Norėdami sukurti naują programą, eikite į

Slack svetainė ir prisijunkite prie savo paskyros. Tada sukurkite naują darbo sritį. Šią darbo sritį naudosite norėdami išbandyti programą prieš įdiegdami ją savo komandos darbo srityje.

Eikite į Slack API svetainė naujame naršyklės skirtuke.

Spustelėkite Jūsų programos mygtuką. Pasirodžiusiame puslapyje spustelėkite Sukurti naują programą mygtuką.

Pasirinkite parinktį sukurti programą nuo nulio. Tada pavadinkite programą ir pasirinkite darbo sritį, kurioje norite ją įdiegti.

Spustelėkite ant Sukurti programą mygtuką. Šis veiksmas sukurs naują „Slack“ programą ir nukreips jus į jos prietaisų skydelį.

2 veiksmas: sukonfigūruokite „Slack Incoming Webhook“.

„Slack Incoming Webhook“ leidžia siųsti pranešimus iš išorinių šaltinių į „Slack“ darbo sritį. Norėdami nustatyti „Webhook“, pasirinkite Įeinantys žiniatinklio kabliukai funkcija. Įsitikinkite, kad įjungėte Suaktyvinkite gaunamus žiniatinklio kabliukus mygtuką.

Slinkite žemyn iki Webhook URL jūsų darbo vietai skyrius. Spustelėkite ant Pridėti naują Webhook prie darbo srities mygtuką.

„Slack“ paprašys pasirinkti kanalą, kuriame jūsų programa skelbs pranešimus. Pasirinkite kanalą ir spustelėkite Leisti mygtuką.

Taip jūsų programa bus pridėta prie pasirinkto kanalo. Grįžkite į Webhook URL jūsų darbo vietai skyrius. Nukopijuokite sugeneruotą Webhook URL. Tai yra URL, į kurį „GitHub“ išsiųs pranešimus apie saugyklos įvykį.

Dabar baigėte konfigūruoti „Slack“ pusę.

3 veiksmas: sukonfigūruokite „GitHub Repo“.

Eikite į GitHub svetainė ir prisijunkite prie savo paskyros. Eikite į saugyklą, iš kurios norite gauti pranešimus apie įvykį. Tu taip pat gali sukurti naują saugyklą. Spustelėkite ant Veiksmai skirtuką po saugyklos pavadinimu.

Tada spustelėkite patys nustatykite darbo eigą nuoroda. Kitame rodomame puslapyje reikia sukurti YAML failą GitHub darbo eigos kataloge. Šis failas apibrėžia „GitHub Actions“ darbo eigą, atsakingą už pranešimų siuntimą į „Slack“ darbo sritį.

YAML kodą parašysite integruotame redaktoriuje. Šis kodas integruos „GitHub“ su „Slack“, siųsdamas pranešimus „Slack“ kanalui, kai saugykloje įvyks konkretūs įvykiai.

Visą šiame straipsnyje naudojamą šaltinio kodą rasite a GitHub saugykla.

4 veiksmas: parašykite YAML kodą, skirtą „GitHub“ integravimui su „Slack“.

Pavadinkite savo darbo eigą. Nedvejodami išsirinkite jums patinkantį pavadinimą.

vardas:LaisvasPranešimas

Nurodykite įvykius, kurie suaktyvins darbo eigą. Čia galite pasirinkti įvykius, apie kuriuos norite, kad jūsų komanda būtų įspėta. Pridėkite arba pašalinkite įvykius, kad atitiktų jūsų poreikius.

ant:
stumti:
pull_request:
Problemos:
tipai:
-atidaryta
-uždaryta
-vėl atidaryta
-redagavo
-ištrintas
-prisegta
-atsegtas
-paskirtas
-nepriskirtas
-pažymėtas
-nepaženklintas
-paženklintas
-nukritęs
issue_comment:
tipai:[sukūrė,redaguota,ištrinta]
sukurti:
Ištrinti:

Konfigūruokite savo darbą ir pasirinkite virtualią aplinką, kurioje jis veiks. notify_slack yra darbo pavadinimas. Galite jį pakeisti pagal savo skonį.

darbai:
notify_slack:
bėgimas:ubuntu naujausias

Nustatykite veiksmą, kuris bus atsakingas už pranešimo siuntimą „Slack“.

žingsniai:
-vardas:SiųstiLaisvaspranešimas

Apibrėžkite aplinkos kintamąjį pavadinimu SLACK_WEBHOOK_URL. Jis išsaugos „Slack Webhook“ URL. Vėliau pridėsite URL prie „GitHub“ saugyklos paslapčių.

env:
SLACK_WEBHOOK_URL:${{paslapčių. SLACK_WEBHOOK_URL}}

Konfigūruoti veiksmingumas „GitHub“ veiksmas. Tai yra trečiosios šalies veiksmas, tvarkantis pagrindinę sąveikos su Slack API logiką. Tai leidžia sutelkti dėmesį į pranešimų ir įvykių, kurie suaktyvina pranešimus, konfigūravimą. Tai labai palengvina pranešimų siuntimo į „Slack“ procesą.

naudoja:8398a7/action-slack@v3

Šis kodas naudoja 8398a7/action-slack@v3veiksmas.

Konfigūruoti 8398a7/action-slack@v3 veiksmas su pasirinktiniais parametrais. The statusą parametras nustato pranešimo būseną į paprotys. Tai leis jums apibrėžti Slack pranešimo turinį naudojant pasirinktinį naudingąjį krovinį. The laukai parametras išvardija laukus, kuriuos reikia įtraukti į Slack pranešimą.

su:
būsena:paprotys
laukai:atpirkimas, įsipareigojimas, įvykis, veiksmas, darbo eiga, nuoroda, URL

Sukurti custom_payload kuri pritaikys Slack pranešimo išvaizdą pagal jūsų pageidavimus.

custom_payload:|
{
"priedai":[
{
"spalva":"${{darbo būsena }}",
"pavadinimas":>-
${{github.aktorius}}${{github.event.pull_request&&github.event.pull_request.merged==tiesa&&„sujungė ištraukimo užklausą“||github.event.pull_request&&„atidarė ištraukimo užklausą“||github.event_name=="stumti"&&„passtūmė naujus pakeitimus“||github.event_name=='kurti'&&„sukūrė naują šaką arba žymą“||github.event_name=='Ištrinti'&&„ištrynė šaką arba žymą“||github.event_name=='Problemos'&&github.event.action||„suaktyvino įvykį“}},
"tekstas":>-
:tada:Renginio informacija:

-Saugykla:${{github.repository}}
-Filialas:${{github.ref}}
-Pranešimas:${{github.event_name=="stumti"&&github.event.head_commit.message||github.event_name=='Problemos'&&github.event.issue.title||github.event_name=='pull_request'&&github.event.pull_request.title||''}}
-:globe_with_meridians:Nuoroda:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Galite kreiptis į 8398a7/action-slack@v3 pritaikytas naudojimo atvejis kad rastumėte visus palaikomus tinkinimus. Įveskite YAML failą, kad sukurtumėte naują darbo eigą.

Paskutinis „GitHub“ integravimo su „Slack“ veiksmas yra naujos saugyklos paslapties pridėjimas. Paslaptis šiuo atveju yra Slack Webhook URL nukopijavai iš Slack. Laikykite šį URL paslaptyje, nes visi, turintys prieigą prie jo, gali siųsti pranešimus į jūsų darbo sritį.

Eikite į saugyklos nustatymus. Spustelėkite ant paslaptys ir kintamieji pagal saugumo funkcija. Pasirinkite Veiksmai variantas.

Spustelėkite Nauja saugyklos paslaptis. Pridėkite paslapties pavadinimą kaip SLACK_WEBHOOK_URL. Tada įklijuokite Laisvas URL į paslapčių lauką. Galiausiai spustelėkite Pridėti paslaptį mygtuką, kad išsaugotumėte naują paslaptį.

Baigėte integruoti „GitHub“ su „Slack“. Kiekvieną kartą, kai jūsų saugykloje įvyks įvykis, kanale bus rodomas pranešimas. Bandyti sukurti naują ištraukimo užklausą. Tai suaktyvins stūmimo įvykį.

Toliau pateiktoje ekrano kopijoje rodomi „Slack“ pranešimų pavyzdžiai, rodantys įvykius, įvykusius saugykloje.

Galite tinkinti pranešimo naudingumą, kad įtrauktumėte kitus laukus, kurie jums gali būti reikalingi.

Pagerinkite savo produktyvumą naudodami „Slack“ integraciją

„GitHub“ nėra vienintelė „Slack“ integracija, kurią galite įtraukti į savo darbo sritį. Yra daug integracijų, kurias galite naudoti norėdami pagerinti savo komandos produktyvumą ir pagerinti jų bendravimą. Susipažinimas su šiomis integracijomis padės supaprastinti komandos darbo eigą ir išlaikyti visus tame pačiame puslapyje.