Kā integrēt GitHub ar Slack, izmantojot Slack API

GitHub integrēšana ar Slack palīdzēs racionalizēt komandas saziņu, informējot viņus par reāllaika repozitorija notikumiem. Šī integrācija palīdz efektīvāk sadarboties, apspriest izmaiņas koda bāzes kontekstā un ātri novērst visas problēmas, kas var rasties izstrādes laikā.

Turklāt GitHub integrēšana ar Slack ļauj pielāgot paziņojumus, lai tie atbilstu jūsu komandas unikālajai darbplūsmai. Tas samazina traucējošos faktorus un koncentrējas uz to, kas patiešām ir svarīgs. Šī pielāgotā komunikācijas pieeja sniedz jūsu komandai iespēju pieņemt pārdomātus lēmumus un veikt savlaicīgas darbības, nodrošinot augstākās kvalitātes rezultātu.

1. darbība. Izveidojiet jaunu Slack lietotni

Lai sekotu līdzi, jums vajadzētu justies ērti izmantojot Slack platformu. Jums vajadzētu būt arī pazīstamam ar GitHub.

Pirmais integrācijas solis ir jaunas Slack lietotnes izveide. Šī lietotne būs atbildīga par ziņojumu publicēšanu atlasītajā Slack kanālā, kad notiks repozitorija notikums. Lai izveidotu jaunu lietotni, dodieties uz

Slack vietne un pierakstieties savā kontā. Pēc tam izveidojiet jaunu darbvietu. Jūs izmantosit šo darbvietu, lai pārbaudītu savu lietotni pirms tās instalēšanas savas komandas darbvietā.

Dodieties uz Slack API vietne jaunā pārlūkprogrammas cilnē.

Klikšķiniet uz Jūsu lietotnes pogu. Parādītajā lapā noklikšķiniet uz Izveidot jaunu lietotni pogu.

Izvēlieties iespēju izveidot lietotni no jauna. Pēc tam nosauciet savu lietotni un izvēlieties darbvietu, kurā vēlaties to instalēt.

Noklikšķiniet uz Izveidot lietotni pogu. Šī darbība izveidos jūsu jauno Slack lietotni un novirzīs jūs uz tās informācijas paneli.

2. darbība: iestatiet atslābtu ienākošo tīmekļa aizķeri

Slack ienākošā tīmekļa aizķere ļauj nosūtīt ziņojumus no ārējiem avotiem uz jūsu Slack darbvietu. Lai iestatītu tīmekļa aizķeri, izvēlieties Ienākošie tīmekļa aizķeri funkciju. Noteikti ieslēdziet Aktivizējiet ienākošos tīmekļa aizķeres pogu.

Ritiniet uz leju līdz Tīmekļa aizķeres vietrāži URL jūsu darbvietai sadaļā. Noklikšķiniet uz Pievienojiet darbvietai jaunu tīmekļa aizķeri pogu.

Slack lūgs jums izvēlēties kanālu, kurā jūsu lietotne publicēs ziņojumus. Izvēlieties kanālu un noklikšķiniet uz Atļaut pogu.

Tādējādi jūsu lietotne tiks pievienota atlasītajam kanālam. Dodieties atpakaļ uz Tīmekļa aizķeres vietrāži URL jūsu darbvietai sadaļā. Kopējiet ģenerēto Tīmekļa aizķeres URL. Šis ir URL, uz kuru GitHub nosūtīs paziņojumus par repozitorija notikumiem.

Tagad esat pabeidzis Slack puses konfigurēšanu.

3. darbība: konfigurējiet GitHub Repo

Dodieties uz GitHub vietne un pierakstieties savā kontā. Dodieties uz repozitoriju, no kura vēlaties saņemt notikumu paziņojumus. Jūs varat arī izveidot jaunu repozitoriju. Noklikšķiniet uz Darbības cilni zem repozitorija nosaukuma.

Pēc tam noklikšķiniet uz pats izveidojiet darbplūsmu saite. Nākamajā lapā, kas tiek parādīta, ir jāizveido YAML fails GitHub darbplūsmu direktorijā. Šis fails nosaka GitHub Actions darbplūsmu, kas ir atbildīga par paziņojumu nosūtīšanu uz jūsu Slack darbvietu.

Jūs ierakstīsit YAML kodu integrētajā redaktorā. Šis kods integrēs GitHub ar Slack, nosūtot paziņojumus uz Slack kanālu, kad repozitorijā notiek konkrēti notikumi.

Pilns šajā rakstā izmantotais pirmkods ir pieejams a GitHub repozitorijs.

4. darbība: uzrakstiet YAML kodu GitHub integrēšanai ar Slack

Nosauciet savu darbplūsmu. Jūtieties brīvi izvēlēties sev tīkamu nosaukumu.

nosaukums:AtslābumsPaziņojums

Norādiet notikumus, kas aktivizēs darbplūsmu. Šeit jūs varat izvēlēties notikumus, par kuriem vēlaties, lai jūsu komanda tiktu informēta. Pievienojiet vai noņemiet notikumus, lai tie atbilstu jūsu prasībām.

uz:
push:
pull_request:
problēmas:
veidi:
-atvērts
-slēgts
-atkārtoti atvērts
-rediģēts
-dzēsts
-piesprausta
-atsprausts
-piešķirts
-nepiešķirts
-marķēti
-bez etiķetes
-pavērsiena punkts
-demilestones
issue_comment:
veidi:[izveidots,rediģēts,dzēsts]
izveidot:
dzēst:

Konfigurējiet savu darbu un izvēlieties virtuālo vidi, kurā tas darbosies. notify_slack ir darba nosaukums. Varat to mainīt pēc savas patikas.

darbavietas:
notify_slack:
uzbrauciens:ubuntu-jaunākais

Iestatiet darbību, kas būs atbildīga par paziņojuma nosūtīšanu Slack.

soļi:
-nosaukums:SūtītAtslābumspaziņojumu

Definējiet vides mainīgo ar nosaukumu SLACK_WEBHOOK_URL. Tas saglabās Slack tīmekļa aizķeres URL. Vēlāk jūs pievienosit vietrādi URL GitHub repozitorija noslēpumiem.

env:
SLACK_WEBHOOK_URL:${{noslēpumi. SLACK_WEBHOOK_URL}}

Konfigurējiet darbības atslābums GitHub darbība. Tā ir trešās puses darbība, kas apstrādā pamata loģiku mijiedarbībai ar Slack API. Tas ļauj koncentrēties uz ziņojumu un notikumu konfigurēšanu, kas aktivizē paziņojumus. Tas ievērojami atvieglo paziņojumu nosūtīšanu uz Slack.

izmanto:8398a7/action-slack@v3

Šis kods izmanto 8398a7/action-slack@v3darbība.

Konfigurējiet 8398a7/action-slack@v3 darbība ar pielāgotiem parametriem. The statusu parametrs iestata ziņojuma statusu uz pasūtījuma. Tas ļaus jums definēt Slack ziņojuma saturu, izmantojot pielāgotu kravnesību. The lauki parametrs uzskaita laukus, kas jāiekļauj ziņojumā Slack.

ar:
statuss:pasūtījuma
lauki:repo, apņemšanās, notikums, darbība, darbplūsma, atsauce, URL

Izveidot a custom_payload kas pielāgos Slack ziņojuma izskatu atbilstoši jūsu vēlmēm.

custom_payload:|
{
"pielikumi":[
{
"krāsa":"${{ darba.statuss }}",
"nosaukums":>-
${{github.aktieris}}${{github.event.pull_request&&github.event.pull_request.merged==taisnība&&"apvienots izvilkšanas pieprasījums"||github.event.pull_request&&"atvēra izvilkšanas pieprasījumu"||github.event_name=="stumt"&&'spieda jaunas izmaiņas'||github.event_name=='radīt'&&'izveidoja jaunu filiāli vai tagu'||github.event_name=='dzēst'&&"izdzēsa filiāli vai atzīmi"||github.event_name=='jautājumi'&&github.event.action||'izraisīja notikumu'}},
"teksts":>-
:tada:Pasākuma informācija:

-Repozitorijs:${{github.repository}}
-Filiāle:${{github.ref}}
-Ziņa:${{github.event_name=="stumt"&&github.event.head_commit.message||github.event_name=='jautājumi'&&github.event.issue.title||github.event_name=='pull_request'&&github.event.pull_request.title||''}}
-:globe_with_meridiāni:Saite:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Jūs varat atsaukties uz 8398a7/action-slack@v3 pielāgotas lietošanas gadījums lai atrastu visus atbalstītos pielāgojumus. Apstipriniet YAML failu, lai izveidotu jaunu darbplūsmu.

Pēdējais solis GitHub integrēšanai ar Slack ir jauna repozitorija noslēpuma pievienošana. Noslēpums šajā gadījumā ir Slack Web aizķeres URL jūs nokopējāt no Slack. Turiet šo URL noslēpumā, jo ikviens, kam ir piekļuve tam, var sūtīt ziņojumus uz jūsu darbvietu.

Pārejiet uz saviem repozitorija iestatījumiem. Noklikšķiniet uz noslēpumi un mainīgie saskaņā drošību funkciju. Izvēlieties Darbības opciju.

Klikšķiniet uz Jauns krātuves noslēpums. Pievienojiet noslēpuma nosaukumu kā SLACK_WEBHOOK_URL. Pēc tam ielīmējiet Viegls URL Slepenajā laukā. Visbeidzot noklikšķiniet uz Pievienot noslēpumu pogu, lai saglabātu jauno noslēpumu.

Tagad esat pabeidzis GitHub integrāciju ar Slack. Katru reizi, kad jūsu krātuvē notiks kāds notikums, jūsu kanālā tiks parādīts ziņojums. Izmēģiniet izveidojot jaunu vilkšanas pieprasījumu. Tas aktivizēs push notikumu.

Tālāk esošajā ekrānuzņēmumā ir parādīti Slack ziņojumu paraugi, kas parāda notikumus, kas notika krātuvē.

Varat pielāgot ziņojuma lietderīgo slodzi, iekļaujot tajā citus laukus, kas jums varētu šķist nepieciešami.

Uzlabojiet savu produktivitāti, izmantojot Slack integrācijas

GitHub nav vienīgā Slack integrācija, ko varat pievienot savai darbvietai. Ir daudz integrāciju, ko varat izmantot, lai uzlabotu savas komandas produktivitāti un uzlabotu komunikāciju. Iepazīstoties ar šīm integrācijām, varēsiet racionalizēt savas komandas darbplūsmu un saglabāt visus tajā pašā lapā.