GitHubin integrointi Slackin kanssa Slack API: n avulla

GitHubin integrointi Slackin kanssa auttaa sinua virtaviivaistamaan tiimisi viestintää tiedottamalla heille reaaliaikaisista arkiston tapahtumista. Tämä integrointi auttaa tekemään yhteistyötä tehokkaammin, keskustelemaan muutoksista koodikannan kontekstissa ja ratkaisemaan nopeasti kaikki kehitysvaiheessa mahdollisesti ilmenevät huolenaiheet.

Lisäksi integroimalla GitHubin Slackin kanssa voit mukauttaa ilmoituksia tiimisi ainutlaatuiseen työnkulkuun. Tämä minimoi häiriötekijät ja keskittyy olennaiseen. Tämä räätälöity lähestymistapa viestintään antaa tiimillesi mahdollisuuden tehdä tietoon perustuvia päätöksiä ja ryhtyä toimiin oikea-aikaisesti, mikä varmistaa korkealaatuisimman lopputuloksen.

Vaihe 1: Luo uusi Slack-sovellus

Jotta voit jatkaa, sinun tulee olla mukava käyttämällä Slack-alustaa. Sinun pitäisi myös tuntea GitHub.

Ensimmäinen integroinnin vaihe on uuden Slack-sovelluksen luominen. Tämä sovellus on vastuussa viestien lähettämisestä valitulle Slack-kanavalle, kun arkistotapahtuma tapahtuu. Luo uusi sovellus siirtymällä kohtaan

Hidas sivusto ja kirjaudu sisään tilillesi. Luo sitten uusi työtila. Käytät tätä työtilaa sovelluksesi testaamiseen ennen sen asentamista tiimisi työtilaan.

Navigoi kohtaan Slack API -verkkosivusto uudella selaimen välilehdellä.

Klikkaa Sovelluksesi -painiketta. Napsauta näkyviin tulevalla sivulla Luo uusi sovellus -painiketta.

Valitse vaihtoehto luodaksesi sovelluksen tyhjästä. Nimeä sitten sovelluksesi ja valitse työtila, johon haluat asentaa sen.

Klikkaa Luo sovellus -painiketta. Tämä toiminto luo uuden Slack-sovelluksesi ja ohjaa sinut sen kojelautaan.

Vaihe 2: Ota käyttöön löysä saapuvien verkkokoukku

Slack Incoming Webhookin avulla voit lähettää viestejä ulkoisista lähteistä Slack-työtilaan. Voit määrittää webhookin valitsemalla Saapuvat Webhookit ominaisuus. Varmista, että kytket päälle Aktivoi saapuvat Webhookit -painiketta.

Vieritä alas kohtaan Webhook-URL-osoitteet työtilallesi osio. Klikkaa Lisää uusi Webhook työtilaan -painiketta.

Slack pyytää sinua valitsemaan kanavan, jolla sovelluksesi lähettää viestejä. Valitse kanava ja napsauta Sallia -painiketta.

Tämä lisää sovelluksesi valittuun kanavaan. Mene takaisin kohtaan Webhook-URL-osoitteet työtilallesi osio. Kopioi luotu Webhookin URL-osoite. Tämä on URL-osoite, johon GitHub lähettää arkiston tapahtumailmoitukset.

Olet nyt määrittänyt Slack-puolen.

Vaihe 3: Määritä GitHub Repo

Navigoi kohtaan GitHub-verkkosivusto ja kirjaudu sisään tilillesi. Siirry arkistoon, josta haluat vastaanottaa tapahtumailmoitukset. Voit myös luo uusi arkisto. Klikkaa Toiminnot -välilehti arkiston nimen alla.

Napsauta sitten määritä työnkulku itse linkki. Seuraava sivu, joka tulee näkyviin, edellyttää YAML-tiedoston luomista GitHubin työnkulkujen hakemistoon. Tämä tiedosto määrittää GitHub Actions -työnkulun, joka vastaa ilmoitusten lähettämisestä Slack-työtilaan.

Kirjoitat YAML-koodin integroituun editoriin. Tämä koodi integroi GitHubin Slackin kanssa lähettämällä ilmoituksia Slack-kanavalle, kun arkistossa tapahtuu tiettyjä tapahtumia.

Tässä artikkelissa käytetty täydellinen lähdekoodi on saatavilla a GitHub-arkisto.

Vaihe 4: Kirjoita YAML-koodi GitHubin integroimiseksi Slackin kanssa

Nimeä työnkulkusi. Voit vapaasti valita mieleisesi nimen.

nimi:löysäIlmoitus

Määritä tapahtumat, jotka käynnistävät työnkulun. Täältä voit valita tapahtumat, joista haluat tiimillesi ilmoituksen. Lisää tai poista tapahtumia tarpeidesi mukaan.

päällä:
työntää:
pull_request:
ongelmat:
tyypit:
-avattu
-suljettu
-avattu uudelleen
-muokattu
-poistettu
-kiinnitetty
-irrotettu
-määrätty
-määrittämätön
-merkitty
-merkitsemätön
-virstanpylväs
-virstanpylväs
issue_comment:
tyypit:[luotu,muokattu,poistettu]
luoda:
poistaa:

Määritä työsi ja valitse virtuaalinen ympäristö, jossa se suoritetaan. notify_slack on työn nimi. Voit muuttaa sen mieleiseksesi.

työpaikat:
notify_slack:
käy:ubuntu-uusin

Määritä vaihe, joka vastaa ilmoituksen lähettämisestä Slackiin.

askeleet:
-nimi:Lähettäälöysäilmoitus

Määritä ympäristömuuttuja nimeltä SLACK_WEBHOOK_URL. Se tallentaa Slackin webhookin URL-osoitteen. Lisäät URL-osoitteen myöhemmin GitHubin arkiston salaisuuksiin.

env:
SLACK_WEBHOOK_URL:${{salaisuuksia. SLACK_WEBHOOK_URL}}

Määritä toiminnan löysyys GitHub-toiminta. Mikä on kolmannen osapuolen toiminto, joka käsittelee Slack API: n kanssa vuorovaikutuksen taustalla olevaa logiikkaa. Sen avulla voit keskittyä ilmoitukset käynnistävien viestien ja tapahtumien määrittämiseen. Tämä tekee ilmoitusten lähettämisestä Slackiin paljon helpompaa.

käyttää:8398a7/action-slack@v3

Tämä koodi käyttää 8398a7/action-slack@v3toiminta.

Määritä 8398a7/action-slack@v3 toiminto mukautetuilla parametreilla. The Tila parametri asettaa viestin tilaksi mukautettu. Sen avulla voit määrittää Slack-viestin sisällön mukautetun hyötykuorman avulla. The kentät parametri listaa Slack-sanomaan sisällytettävät kentät.

kanssa:
Tila:mukautettu
kentät:repo, sitoumus, tapahtuma, toiminto, työnkulku, viite, URL

Luo custom_payload joka mukauttaa Slack-viestin ulkoasun mieltymystesi mukaan.

custom_payload:|
{
"liitteet":[
{
"väri":"${{ työtilanne }}",
"otsikko":>-
${{github.näyttelijä}}${{github.event.pull_request&&github.event.pull_request.merged==totta&&'yhdistetty vetopyyntö'||github.event.pull_request&&"avoi vetopyynnön"||github.event_name=='työntää'&&"työnsi uusia muutoksia"||github.event_name=='luoda'&&"loi uuden haaran tai tunnisteen"||github.event_name=='poistaa'&&"poisti haaran tai tunnisteen"||github.event_name=='ongelmat'&&github.event.action||"laukaisi tapahtuman"}},
"teksti":>-
:tada:Tapahtuman Yksityiskohdat:

-Arkisto:${{github.repository}}
-Haara:${{github.ref}}
-Viesti:${{github.event_name=='työntää'&&github.event.head_commit.message||github.event_name=='ongelmat'&&github.event.issue.title||github.event_name=='pull_request'&&github.event.pull_request.title||''}}
-:maapallo_meridiaanien kanssa:Linkki:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Voit viitata 8398a7/action-slack@v3 mukautettu käyttötapaus löytääksesi kaikki tuetut mukautukset. Sitouta YAML-tiedosto uuden työnkulun luomiseksi.

Viimeinen vaihe GitHubin integroinnissa Slackin kanssa on uuden arkiston salaisuuden lisääminen. Salaisuus tässä tapauksessa on Slack Webhookin URL-osoite kopioit Slackista. Pidä tämä URL-osoite salassa, koska kuka tahansa, jolla on sen käyttöoikeus, voi lähettää viestejä työtilaan.

Siirry arkistoasetuksiin. Klikkaa salaisuuksia ja muuttujia alla turvallisuus ominaisuus. Valitse Toiminnot vaihtoehto.

Klikkaa Uusi arkiston salaisuus. Lisää salaisuuden nimi nimellä SLACK_WEBHOOK_URL. Liitä sitten Hidas URL-osoite salaiseen kenttään. Napsauta lopuksi Lisää Secret -painiketta tallentaaksesi uuden salaisuuden.

Olet nyt integroinut GitHubin Slackin kanssa. Aina kun arkistossasi tapahtuu tapahtuma, kanavallasi näytetään viesti. Yrittää uuden vetopyynnön luominen. Tämä käynnistää push-tapahtuman.

Alla olevassa kuvakaappauksessa näkyy esimerkkiviestejä Slackin arkistoissa tapahtuneista tapahtumista.

Voit mukauttaa viestin hyötykuormaa sisältämään muita kenttiä, joita saatat pitää tarpeellisena.

Paranna tuottavuuttasi Slack-integraatioilla

GitHub ei ole ainoa Slack-integraatio, jonka voit lisätä työtilaan. On olemassa lukuisia integraatioita, joiden avulla voit parantaa tiimisi tuottavuutta ja parantaa heidän viestintää. Näihin integraatioihin tutustuminen auttaa sinua virtaviivaistamaan tiimisi työnkulkua ja pitämään kaikki samalla sivulla.