Jak integrovat GitHub s Slack pomocí Slack API

Integrace GitHubu se Slack vám pomůže zefektivnit komunikaci vašeho týmu tím, že je budete informovat o událostech úložiště v reálném čase. Tato integrace pomáhá efektivněji spolupracovat, diskutovat o změnách v kontextu kódové základny a rychle řešit jakékoli obavy, které mohou během vývoje nastat.

Navíc integrace GitHubu se Slack vám umožní přizpůsobit oznámení tak, aby vyhovovala jedinečnému pracovnímu postupu vašeho týmu. To minimalizuje rušivé vlivy a zaměřuje se na to, na čem skutečně záleží. Tento přizpůsobený přístup ke komunikaci umožňuje vašemu týmu činit informovaná rozhodnutí a přijímat včasná opatření, což zajišťuje nejvyšší kvalitu výstupu.

Krok 1: Vytvořte novou aplikaci Slack

Abyste mohli pokračovat, měli byste se cítit pohodlně pomocí platformy Slack. Měli byste také znát GitHub.

Prvním krokem integrace je vytvoření nové aplikace Slack. Tato aplikace bude zodpovědná za odesílání zpráv na vybraný kanál Slack, když dojde k události úložiště. Chcete-li vytvořit novou aplikaci, přejděte na

Web Slack a přihlaste se ke svému účtu. Poté vytvořte nový pracovní prostor. Tento pracovní prostor použijete k otestování aplikace před instalací do pracovního prostoru vašeho týmu.

Přejděte na Web Slack API na nové kartě prohlížeče.

Klikněte na Vaše aplikace knoflík. Na stránce, která se zobrazí, klikněte na Vytvořit novou aplikaci knoflík.

Vyberte možnost vytvořit aplikaci od začátku. Poté aplikaci pojmenujte a vyberte pracovní prostor, do kterého ji chcete nainstalovat.

Klikněte na Vytvořit aplikaci knoflík. Tato akce vytvoří vaši novou aplikaci Slack a přesměruje vás na její řídicí panel.

Krok 2: Nastavte Slack Incoming Webhook

Slack Incoming Webhook vám umožňuje odesílat zprávy z externích zdrojů do vašeho pracovního prostoru Slack. Chcete-li nastavit webhook, vyberte Příchozí webhooky Vlastnosti. Ujistěte se, že jste zapnuli Aktivujte příchozí webhooky knoflík.

Přejděte dolů na Webhookové adresy URL pro váš pracovní prostor sekce. Klikněte na Přidejte nový webhook do pracovního prostoru knoflík.

Slack vás požádá o výběr kanálu, ve kterém bude vaše aplikace odesílat zprávy. Vyberte kanál a klikněte na Dovolit knoflík.

Tím se aplikace přidá do vybraného kanálu. Vraťte se k Webhookové adresy URL pro váš pracovní prostor sekce. Zkopírujte vygenerované Adresa URL webhooku. Toto je adresa URL, na kterou bude GitHub posílat oznámení o událostech úložiště.

Nyní jste hotovi s konfigurací strany Slack.

Krok 3: Nakonfigurujte GitHub Repo

Přejděte na Web GitHub a přihlaste se ke svému účtu. Přejděte do úložiště, ze kterého chcete dostávat oznámení o událostech. Můžete také vytvořit nové úložiště. Klikněte na Akce pod názvem úložiště.

Poté klikněte na nastavit pracovní postup sami odkaz. Následující stránka, která se zobrazí, vyžaduje, abyste vytvořili soubor YAML v adresáři pracovních postupů GitHubu. Tento soubor definuje pracovní postup akcí GitHub zodpovědný za odesílání oznámení do vašeho pracovního prostoru Slack.

Kód YAML napíšete v integrovaném editoru. Tento kód integruje GitHub se Slackem odesíláním upozornění na kanál Slack, když v úložišti nastanou určité události.

Úplný zdrojový kód použitý v tomto článku je k dispozici v a úložiště GitHub.

Krok 4: Napište YAML kód pro integraci GitHubu se Slackem

Pojmenujte svůj pracovní postup. Neváhejte a vyberte si jméno podle svého gusta.

název:SlackOznámení

Zadejte události, které spustí pracovní postup. Zde si vyberete události, o kterých chcete, aby byl váš tým informován. Přidejte nebo odeberte události podle vašich požadavků.

na:
TAM:
pull_request:
problémy:
typy:
-otevřel
-ZAVŘENO
-znovu otevřen
-upraveno
-smazáno
-připnutý
-odepnuto
-přiděleno
-Nepřiřazeno
-označené
-neoznačené
-milník
-demilestones
issue_comment:
typy:[vytvořeno,upraveno,smazáno]
vytvořit:
vymazat:

Nakonfigurujte svou úlohu a vyberte virtuální prostředí, ve kterém poběží. notify_slack je název práce. Můžete to změnit podle svého.

pracovní místa:
notify_slack:
nájezdy:ubuntu-nejnovější

Nastavte krok, který bude zodpovědný za odesílání upozornění do Slacku.

kroky:
-název:PoslatSlackoznámení

Definujte proměnnou prostředí s názvem SLACK_WEBHOOK_URL. Uloží adresu URL webhooku Slack. Později přidáte adresu URL do tajných klíčů úložiště GitHub.

env:
SLACK_WEBHOOK_URL:${{tajemství. SLACK_WEBHOOK_URL}}

Nakonfigurujte akce-slack Akce GitHub. Což je akce třetí strany, která zpracovává základní logiku interakce s rozhraním Slack API. Umožňuje vám soustředit se na konfiguraci zpráv a událostí, které spouštějí oznámení. Díky tomu je proces odesílání upozornění na Slack mnohem jednodušší.

používá:8398a7/action-slack@v3

Tento kód používá 8398a7/action-slack@v3akce.

Nakonfigurujte 8398a7/action-slack@v3 akce s vlastními parametry. The postavení parametr nastavuje stav zprávy na Zvyk. Umožní vám definovat obsah zprávy Slack pomocí vlastního užitečného zatížení. The pole Parametr uvádí pole, která mají být zahrnuta do zprávy Slack.

s:
postavení:Zvyk
pole:repo, potvrzení, událost, akce, pracovní postup, odkaz, URL

Vytvořit custom_payload která přizpůsobí vzhled zprávy Slack tak, aby vyhovovala vašim preferencím.

custom_payload:|
{
"přílohy":[
{
"barva":"${{ pracovní status }}",
"titul":>-
${{github.herec}}${{github.event.pull_request&&github.event.pull_request.merged==skutečný&&'sloučeno žádost o stažení'||github.event.pull_request&&'otevřel žádost o stažení'||github.event_name=='TAM'&&'prosadil nové změny'||github.event_name=='vytvořit'&&'vytvořil novou větev nebo značku'||github.event_name=='vymazat'&&'smazána větev nebo značka'||github.event_name=='problémy'&&github.event.action||'spustil událost'}},
"text":>-
:tada:Podrobnosti o akci:

-úložiště:${{github.repository}}
-Větev:${{github.ref}}
-Zpráva:${{github.event_name=='TAM'&&github.event.head_commit.message||github.event_name=='problémy'&&github.event.issue.title||github.event_name=='pull_request'&&github.event.pull_request.title||''}}
-:globe_with_meridians:Odkaz:${{github.event.pull_request.html_url||github.event.issue.html_url||github.event.repository.html_url}}
}

]
}

Můžete odkazovat na 8398a7/action-slack@v3 případ vlastního použití najít všechna podporovaná přizpůsobení. Chcete-li vytvořit nový pracovní postup, potvrďte soubor YAML.

Posledním krokem integrace GitHubu se Slackem je přidání nového tajemství úložiště. Tajemstvím v tomto případě je Slack webhook URL zkopírovali jste ze Slacku. Udržujte tuto adresu URL v tajnosti, protože kdokoli, kdo k ní má přístup, může odesílat zprávy do vašeho pracovního prostoru.

Přejděte do nastavení úložiště. Klikněte na tajemství a proměnné pod bezpečnostní Vlastnosti. Vybrat Akce volba.

Klikněte na Nové tajemství úložiště. Přidejte název tajenky jako SLACK_WEBHOOK_URL. Poté vložte Slack URL do tajného pole. Nakonec klikněte na Přidat tajné tlačítko pro uložení nového tajemství.

Nyní jste dokončili integraci GitHubu se Slackem. Pokaždé, když se ve vašem úložišti stane událost, ve vašem kanálu se zobrazí zpráva. Snaž se vytvoření nového požadavku na stažení. Tím se spustí událost push.

Níže uvedený snímek obrazovky ukazuje ukázkové zprávy na Slacku ukazující události, které se odehrály v úložišti.

Obsah zprávy můžete přizpůsobit tak, aby zahrnoval další pole, která můžete považovat za nezbytná.

Zlepšete svou produktivitu pomocí Slack Integrations

GitHub není jediná integrace Slack, kterou můžete přidat do svého pracovního prostoru. Existuje mnoho integrací, které můžete použít ke zlepšení produktivity vašeho týmu a zlepšení jejich komunikace. Seznámení s těmito integracemi vám pomůže zefektivnit pracovní postup vašeho týmu a udržet všechny na stejné stránce.