Kuidas integreerida GitHub Slackiga Slacki API abil

GitHubi integreerimine Slackiga aitab teil oma meeskonna suhtlust sujuvamaks muuta, teavitades neid reaalajas hoidla sündmustest. See integratsioon aitab tõhusamalt koostööd teha, arutada muudatusi koodibaasi kontekstis ja kiiresti lahendada arenduse käigus tekkida võivaid probleeme.

Lisaks võimaldab GitHubi integreerimine Slackiga kohandada teatisi, et need sobiksid teie meeskonna ainulaadse töövooga. See vähendab segajaid ja keskendub sellele, mis on tõeliselt oluline. See kohandatud lähenemine suhtlemisele annab teie meeskonnale võimaluse teha teadlikke otsuseid ja võtta õigeaegseid meetmeid, tagades kõrgeima kvaliteediga väljundi.

1. samm: looge uus Slacki rakendus

Läbimiseks peaksite olema mugav kasutades Slacki platvormi. Samuti peaksite olema tuttav GitHubiga.

Integreerimise esimene samm on uue Slacki rakenduse loomine. See rakendus vastutab hoidla sündmuse korral valitud Slacki kanalile sõnumite postitamise eest. Uue rakenduse loomiseks liikuge lehele

Slack veebisait ja logige sisse oma kontole. Seejärel looge uus tööruum. Kasutate seda tööruumi oma rakenduse testimiseks enne selle installimist oma meeskonna tööruumi.

Navigeerige lehele Slacki API veebisait uuel brauseri vahekaardil.

Kliki Teie rakendused nuppu. Ilmuval lehel klõpsake nuppu Loo uus rakendus nuppu.

Valige suvand, et luua rakendus nullist. Seejärel nimetage oma rakendus ja valige tööruum, kuhu soovite selle installida.

Klõpsake nuppu Loo rakendus nuppu. See toiming loob teie uue Slacki rakenduse ja suunab teid selle armatuurlauale.

2. samm: seadistage sissetulevate sissetulevate veebihaagide lõdvestumine

Slacki sissetulevate veebihaagide abil saate saata sõnumeid välistest allikatest oma Slacki tööruumi. Veebihaagi seadistamiseks valige Sissetulevad veebihaagid tunnusjoon. Veenduge, et lülitaksite sisse Sissetulevate veebihaagide aktiveerimine nuppu.

Kerige alla jaotiseni Veebihaagi URL-id teie tööruumi jaoks osa. Klõpsake nuppu Lisage tööruumi uus veebihaak nuppu.

Slack palub teil valida kanali, kuhu teie rakendus sõnumeid postitab. Valige kanal ja klõpsake nuppu Lubama nuppu.

See lisab teie rakenduse valitud kanalile. Mine tagasi Veebihaagi URL-id teie tööruumi jaoks osa. Kopeerige loodud Veebihaagi URL. See on URL, millele GitHub saadab hoidla sündmuste teatised.

Nüüd olete Slacki poole konfigureerimise lõpetanud.

3. samm: konfigureerige GitHub Repo

Navigeerige lehele GitHubi veebisait ja logige sisse oma kontole. Minge hoidlasse, kust soovite sündmuste märguandeid saada. Sa saad ka luua uus hoidla. Klõpsake nuppu Tegevused vahekaarti hoidla nime all.

Seejärel klõpsake nuppu loo ise töövoog link. Järgmisel ilmuval lehel peate looma GitHubi töövoogude kataloogis YAML-faili. See fail määratleb GitHub Actionsi töövoo, mis vastutab teie Slacki tööruumi teatiste saatmise eest.

YAML-koodi kirjutate integreeritud redaktoris. See kood integreerib GitHubi Slackiga, saates teavitused Slacki kanalile, kui hoidlas toimuvad konkreetsed sündmused.

Selles artiklis kasutatud täielik lähtekood on saadaval a GitHubi hoidla.

4. samm: kirjutage YAML-kood GitHubi integreerimiseks Slackiga

Nimetage oma töövoog. Valige julgelt endale meelepärane nimi.

nimi:LoidTeavitus

Määrake sündmused, mis käivitavad töövoo. Siin saate valida sündmused, millest soovite oma meeskonda teavitada. Lisage või eemaldage sündmusi vastavalt teie vajadustele.

peal:
suruma:
pull_request:
probleemid:
tüübid:
-avatud
-suletud
-uuesti avatud
-toimetatud
-kustutatud
-kinnitatud
-lahti kinnitatud
-määratud
-määramata
-märgistatud
-märgistamata
-verstapostid
-murdeealine
issue_comment:
tüübid:[loodud,redigeeritud,kustutatud]
loo:
kustuta:

Seadistage oma töö ja valige virtuaalne keskkond, milles see töötab. teata_slack on töö nimi. Saate seda oma maitse järgi muuta.

töökohad:
notify_slack:
pealejooks:ubuntu uusim

Seadistage samm, mis vastutab Slackile teatise saatmise eest.

sammud:
-nimi:SaadaLoidteatis

Määratlege nimega keskkonnamuutuja SLACK_WEBHOOK_URL. See salvestab Slacki veebihaagi URL-i. Hiljem lisate URL-i GitHubi hoidla saladustesse.

env:
SLACK_WEBHOOK_URL:${{saladusi. SLACK_WEBHOOK_URL}}

Seadistage tegevusetus GitHubi tegevus. See on kolmanda osapoole toiming, mis käsitleb Slacki API-ga suhtlemise aluseks olevat loogikat. See võimaldab teil keskenduda märguandeid käivitavate sõnumite ja sündmuste konfigureerimisele. See muudab Slackile teatiste saatmise palju lihtsamaks.

kasutab:8398a7/action-slack@v3

See kood kasutab 8398a7/action-slack@v3tegevust.

Seadistage 8398a7/action-slack@v3 kohandatud parameetritega toiming. The olek parameeter määrab sõnumi olekuks kohandatud. See võimaldab teil määratleda Slacki sõnumi sisu kohandatud kasuliku koormuse abil. The väljad parameeter loetleb väljad, mis Slacki sõnumisse kaasatakse.

koos:
olek:kohandatud
väljad:repo, sidumine, sündmus, toiming, töövoog, viide, URL

Loo custom_payload mis kohandab Slacki sõnumi välimust vastavalt teie eelistustele.

custom_payload:|
{
"manused":[
{
"värv":"${{ töö.status }}",
"pealkiri":>-
${{github.actor}}${{github.event.pull_request&&github.event.pull_request.merged==tõsi&&"ühendas tõmbamistaotluse"||github.event.pull_request&&'avanud tõmbetaotluse'||github.sündmuse_nimi=='tõukama'&&"surutas uusi muudatusi"||github.sündmuse_nimi=='loo'&&'lõi uue haru või sildi'||github.sündmuse_nimi=='kustuta'&&'kustutas haru või sildi'||github.sündmuse_nimi=='probleemid'&&github.event.action||"käivitas sündmuse"}},
"tekst":>-
:tada:Sündmuse üksikasjad:

-Hoidla:${{github.repository}}
-Filiaal:${{github.ref}}
-Sõnum:${{github.sündmuse_nimi=='tõukama'&&github.event.head_commit.message||github.sündmuse_nimi=='probleemid'&&github.event.issue.title||github.sündmuse_nimi=='pull_request'&&github.event.pull_request.title||''}}
-:gloobus_meridiaanidega:Link:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Võite viidata 8398a7/action-slack@v3 kohandatud kasutusjuht et leida kõik toetatud kohandused. Kinnitage YAML-fail uue töövoo loomiseks.

GitHubi Slackiga integreerimise viimane samm on uue hoidlasaladuse lisamine. Sel juhul on saladus Slack Webhaoki URL kopeerisite Slackist. Hoidke seda URL-i salajas, sest igaüks, kellel on sellele juurdepääs, saab teie tööruumi sõnumeid saata.

Liikuge oma hoidla sätete juurde. Klõpsake nuppu saladused ja muutujad all turvalisus tunnusjoon. Valige Tegevused valik.

Kliki Uus hoidla saladus. Lisage saladuse nimi kui SLACK_WEBHOOK_URL. Seejärel kleepige Lahtine URL väljale Saladus. Lõpuks klõpsake nuppu Lisage saladus nuppu uue saladuse salvestamiseks.

Olete nüüd lõpetanud GitHubi integreerimise Slackiga. Iga kord, kui teie hoidlas toimub sündmus, kuvatakse teie kanalil teade. Proovi uue tõmbamistaotluse loomine. See käivitab tõukesündmuse.

Alloleval ekraanipildil on Slacki näidissõnumid, mis näitavad hoidlas toimunud sündmusi.

Saate kohandada sõnumite koormust, et see sisaldaks muid vajalikke välju.

Parandage oma tootlikkust Slack-integratsioonidega

GitHub pole ainus Slacki integratsioon, mille saate oma tööruumi lisada. Seal on palju integratsioone, mida saate kasutada oma meeskonna tootlikkuse parandamiseks ja nende suhtluse parandamiseks. Nende integratsioonidega tutvumine aitab teil oma meeskonna töövoogu sujuvamaks muuta ja hoida kõik samal lehel.