A GitHub integrálása a Slackkal a Slack API használatával

A GitHub és a Slack integrálása segít a csapat kommunikációjának egyszerűsítésében azáltal, hogy tájékoztatja őket a valós idejű adattári eseményekről. Ez az integráció segít a hatékonyabb együttműködésben, a kódbázis kontextusában bekövetkezett változások megbeszélésében, és a fejlesztés során felmerülő problémák gyors megoldásában.

Ezenkívül a GitHub és a Slack integrálása lehetővé teszi az értesítések testreszabását a csapat egyedi munkafolyamatának megfelelően. Ez minimálisra csökkenti a zavaró tényezőket, és arra összpontosít, ami igazán számít. A kommunikációnak ez a személyre szabott megközelítése felhatalmazza csapatát arra, hogy megalapozott döntéseket hozzon, és időben tegyen lépéseket, biztosítva a legjobb minőségű kimenetet.

1. lépés: Hozzon létre egy új Slack alkalmazást

A követéshez kényelmesnek kell lennie a Slack platform használatával. A GitHub-ot is ismernie kell.

Az integráció első lépése egy új Slack alkalmazás létrehozása. Ez az alkalmazás lesz felelős az üzenetek közzétételéért a kiválasztott Slack csatornán, ha tárhelyesemény történik. Új alkalmazás létrehozásához navigáljon a

Laza weboldal és jelentkezzen be fiókjába. Ezután hozzon létre egy új munkaterületet. Ezt a munkaterületet fogja használni az alkalmazás tesztelésére, mielőtt telepítené azt a csapata munkaterületére.

Navigáljon a Slack API webhely egy új böngészőlapon.

Kattintson Az Ön alkalmazásai gomb. A megjelenő oldalon kattintson a Új alkalmazás létrehozása gomb.

Válassza azt a lehetőséget, hogy az alkalmazást a semmiből hozza létre. Ezután nevezze el az alkalmazást, és válassza ki azt a munkaterületet, amelyre telepíteni szeretné.

Kattintson a Alkalmazás létrehozása gomb. Ez a művelet létrehozza az új Slack alkalmazást, és átirányítja az irányítópultjára.

2. lépés: Állítson be egy laza bejövő webhookot

A Slack bejövő webhook segítségével külső forrásokból üzeneteket küldhet a Slack munkaterületére. A webhook beállításához válassza a lehetőséget Bejövő webhookok funkció. Ügyeljen arra, hogy bekapcsolja a Aktiválja a bejövő webhookot gomb.

Görgessen le a Webhook URL-ek az Ön munkaterületéhez szakasz. Kattintson a Új Webhook hozzáadása a munkaterülethez gomb.

A Slack kérni fogja, hogy válassza ki azt a csatornát, amelyen az alkalmazás üzeneteket fog közzétenni. Válassza ki a csatornát, és kattintson a gombra Lehetővé teszi gomb.

Ezzel hozzáadja az alkalmazást a kiválasztott csatornához. Menj vissza a Webhook URL-ek az Ön munkaterületéhez szakasz. Másolja a generált Webhook URL. Ez az az URL, amelyre a GitHub elküldi a lerakat eseményeiről szóló értesítéseket.

Ezzel befejezte a Slack oldal konfigurálását.

3. lépés: A GitHub Repo konfigurálása

Navigáljon a GitHub webhely és jelentkezzen be fiókjába. Nyissa meg azt a tárat, amelyről az eseményértesítéseket szeretné kapni. Te is hozzon létre egy új tárolót. Kattintson a Akciók fület a lerakat neve alatt.

Ezután kattintson a saját maga állítson be egy munkafolyamatot link. A következő oldalon megjelenik egy YAML-fájl létrehozása a GitHub-munkafolyamatok könyvtárában. Ez a fájl határozza meg a GitHub-műveletek munkafolyamatát, amely a Slack-munkaterületre történő értesítések küldéséért felelős.

A YAML kódot az integrált szerkesztőbe kell írni. Ez a kód integrálja a GitHubot a Slack-kel azáltal, hogy értesítéseket küld egy Slack-csatornának, amikor bizonyos események fordulnak elő az adattárban.

A cikkben használt teljes forráskód elérhető a GitHub adattár.

4. lépés: Írja meg a YAML-kódot a GitHub és a Slack integrálásához

Nevezze el a munkafolyamatot. Nyugodtan válaszd ki a kedvedre való nevet.

név:LazaÉrtesítés

Adja meg azokat az eseményeket, amelyek elindítják a munkafolyamatot. Itt választhatja ki azokat az eseményeket, amelyekről értesíteni szeretné csapatát. Adja hozzá vagy távolítsa el az eseményeket az Ön igényei szerint.

tovább:
nyom:
pull_request:
problémák:
típusok:
-nyitott
-zárva
-újra megnyílt
-szerkesztette
-törölve
-feltűzve
-kicsavarva
-kijelölt
-nincs hozzárendelve
-feliratú
-jelöletlen
-mérföldkőnek számító
-mérföldkőhöz kötött
issue_comment:
típusok:[létrehozva,szerkesztve,törölve]
teremt:
töröl:

Konfigurálja a feladatot, és válassza ki a virtuális környezetet, amelyen futni fog. notify_slack a munka neve. Tetszés szerint módosíthatja.

állások:
notify_slack:
ráfutás:ubuntu-legújabb

Állítson be egy lépést, amely felelős az értesítés Slacknek történő elküldéséért.

lépések:
-név:KüldLazaértesítés

Adjon meg egy nevű környezeti változót SLACK_WEBHOOK_URL. Tárolja a Slack webhook URL-jét. Később hozzáadja az URL-t a GitHub adattár titkaihoz.

env:
SLACK_WEBHOOK_URL:${{titkok. SLACK_WEBHOOK_URL}}

Konfigurálja a cselekvő lazaság GitHub-akció. Ez egy harmadik féltől származó művelet, amely kezeli a Slack API-val való interakció mögöttes logikáját. Lehetővé teszi, hogy az értesítéseket kiváltó üzenetek és események konfigurálására összpontosítson. Ez sokkal egyszerűbbé teszi az értesítések Slack felé történő küldésének folyamatát.

használja:8398a7/action-slack@v3

Ez a kód a 8398a7/action-slack@v3akció.

Konfigurálja a 8398a7/action-slack@v3 művelet egyéni paraméterekkel. A állapot paraméter beállítja az üzenet állapotát egyedi. Lehetővé teszi a Slack-üzenet tartalmának meghatározását egy egyedi rakomány segítségével. A mezőket paraméter listázza a Slack üzenetbe foglalandó mezőket.

val vel:
állapot:egyedi
mezők:repo, véglegesítés, esemény, művelet, munkafolyamat, ref, URL

Hozzon létre egy custom_payload amely az Ön preferenciáinak megfelelően testreszabja a Slack üzenet megjelenését.

custom_payload:|
{
"mellékletek":[
{
"szín":"${{ job.status }}",
"cím":>-
${{github.színész}}${{github.event.pull_request&&github.event.pull_request.merged==igaz&&"összevont egy lehívási kérelmet"||github.event.pull_request&&"megnyitott egy lehívási kérelmet"||github.event_name=='nyom'&&"új változtatásokat hajtott végre"||github.event_name=='teremt'&&"új ágat vagy címkét hozott létre"||github.event_name=='töröl'&&„törölt egy ágat vagy címkét”||github.event_name=='problémák'&&github.event.action||"eseményt váltott ki"}},
"szöveg":>-
:tada:Esemény részletei:

-Adattár:${{github.repository}}
-Ág:${{github.ref}}
-Üzenet:${{github.event_name=='nyom'&&github.event.head_commit.message||github.event_name=='problémák'&&github.event.issue.title||github.event_name=='pull_request'&&github.event.pull_request.title||''}}
-:földgömb_meridiánokkal:Link:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Hivatkozhat a 8398a7/action-slack@v3 egyéni használati eset hogy megtalálja az összes támogatott testreszabást. Végezze el a YAML fájlt az új munkafolyamat létrehozásához.

A GitHub és a Slack integrálásának utolsó lépése egy új adattári titok hozzáadása. A titok ebben az esetben az Slack Webhook URL a Slackből másoltad. Tartsa titokban ezt az URL-t, mert bárki, aki hozzáfér, üzeneteket küldhet az Ön munkaterületére.

Navigáljon a lerakat beállításaihoz. Kattintson a titkok és változók alatt Biztonság funkció. Válaszd ki a Akciók választási lehetőség.

Kattintson Új adattár titka. Adja hozzá a titok nevét mint SLACK_WEBHOOK_URL. Ezután illessze be a Laza URL a Titok mezőbe. Végül kattintson a Adja hozzá a Titkot gombot az új titok mentéséhez.

Ezzel befejezte a GitHub és a Slack integrálását. Minden alkalommal, amikor egy esemény történik a tárhelyedben, egy üzenet jelenik meg a csatornádon. Próbáld ki új lehívási kérelem létrehozása. Ez push eseményt indít el.

Az alábbi képernyőképen a Slack mintaüzenetei láthatók, amelyek egy adattárban történt eseményeket mutatnak be.

Testreszabhatja az üzenetek hasznos tartalmát, hogy más mezőket is tartalmazzon, amelyeket szükségesnek találhat.

Növelje termelékenységét a laza integrációkkal

A GitHub nem az egyetlen Slack-integráció, amelyet hozzáadhat a munkaterületéhez. Számos olyan integráció létezik, amelyek segítségével javíthatja csapata termelékenységét és kommunikációját. Ezen integrációk megismerése segít a csapat munkafolyamatának egyszerűsítésében, és mindenkit ugyanazon az oldalon tarthat.