GitHub Actions je úžasný nástroj, který vám umožní automatizovat různé úkoly ve vašem úložišti. A jednou z nejužitečnějších funkcí Actions je vytváření a zobrazování jmenovek-malých grafických prvků, které informují o stavu vašeho projektu.
Odznaky mohou být použity pro různé účely, od označení stavu sestavení nebo testování až po zobrazení aktuální verze vaší aplikace. Vytváření jmenovek pomocí GitHub Actions je velmi jednoduché a pochopitelné, a to i pro začátečníky v oblasti CI/CD.
V tomto guide se seznámíme se základními kroky potřebnými k vytvoření a konfiguraci odznaků pomocí GitHub Actions. Pochopíme syntaxi souboru YAML, naučíme se přizpůsobit odznaky a přidat je na stránku vašeho projektu. Jste připraveni začít? Pojďme se začít učit tuto jednoduchou, ale velmi užitečnou dovednost!
Použití odznaků na Githubu
Chcete-li přidat značku na svou stránku projektu na Githubu, můžete použít speciální syntaxi značky HTML . Adresou obrázku bude odkaz na stav odznaku, který obsahuje informace o stavu projektu.
V tomto příkladu se zobrazí štítek s textem " build: passing " na zeleném pozadí, což naznačuje, že stavba projektu byla úspěšně dokončena.
Můžete také přidat nastavení do odkazu a přizpůsobit vzhled odznaku:
- label: nastaví text, který se zobrazí na odznaku;
- message: nastaví text, který se zobrazí vedle odznaku;
- color: určuje barvu pozadí odznaku.
Velký výběr jmenovek a speciálních služeb pro vytváření a přizpůsobení jmenovek pomůže učinit vaši stránku projektu informativnější a atraktivnější.
Nyní víte, jak přidat odznaky na GitHub, abyste zobrazili informace o stavu projektu a upozornili na něj.
Co jsou odznaky a proč jsou potřeba
Odznaky se často používají k zobrazení různých metrik nebo stavů projektu, jako jsou: verze softwaru, stav sestavení, pokrytí kódu testy, počet závislostí atd. umožňují rychlé a vizuální získání informací o projektu a také zvyšují jeho atraktivitu a profesionální vzhled.
K vytvoření odznaku stačí použít speciální služby, které poskytují šablony pro různé typy odznaků a automaticky generují kód pro jejich vložení na web nebo do README. Tyto služby obvykle podporují různé platformy a nástroje, včetně GitHub Actions.
Odznaky jsou šikovným nástrojem pro vizualizaci různých metrik a statusů projektu. Pomáhají vývojářům a uživatelům rychle získat informace o projektu a také motivují k udržení vysoké úrovně kvality a produktivity.
Výhody používání odznaků v projektu
- Upoutání pozornosti: Odznaky mohou být živými a atraktivními prvky, které okamžitě upoutají pozornost uživatelů k vašemu projektu.
- Informativnost: Štítky mohou poskytovat různé informace o stavu projektu, jako je stav sestavení, pokrytí testy, Poslední commit a další metriky.
- Profesionalita: Použití odznaků v projektu může vyvolat dojem profesionality a seriózního přístupu k vývoji. Mohou sloužit jako důkaz, že váš projekt je v aktivním vývoji a sleduje nejlepší vývojové postupy.
- Pohodlí: Odznaky poskytují rychlý a snadný způsob, jak zobrazit informace o projektu, aniž byste museli zadávat mnoho textu. Zabírají minimum místa a umožňují poskytnout informace ve vizuální a kompaktní podobě.
- Zlepšení vnímání uživatelů: Odznaky mohou uživatelům pomoci lépe porozumět a ocenit váš projekt. Například použití odznaků se stavem sestavení může uživatelům pomoci pochopit, jak spolehlivý a stabilní je váš projekt.
Obecně platí, že použití odznaků v projektu vám může pomoci zlepšit vizuální prezentaci vašeho projektu, poskytnout uživatelům užitečné informace a upozornit na vaši práci.
Návod k vytvoření odznaků na GitHub Actions
Chcete-li vytvořit jmenovku, budete muset do souboru přidat speciální kód README.md. k tomu budete potřebovat znalost syntaxe Markdown. Nejprve se musíte rozhodnout, jaké informace se zobrazí na vaší odznaku. GitHub Actions nabízí mnoho možností, například:
- Stav sestavení: jak úspěšné bylo sestavení vašeho projektu
- Aktuální Bild: informace o aktuálním sestavení projektu
- Pokrytí testy: ukazuje procento pokrytí testy vašeho projektu
- Počet hvězd: zobrazuje počet hvězd, které váš projekt získal
Kód pro vytvoření odznaků v souboru README.md má následující vzhled:
Zde Místo " Text "můžete zadat text, který chcete, a místo" hodnota " hodnotu, kterou chcete zobrazit (například procento pokrytí testy). Místo" Color "můžete zadat barevně kód nebo název barvy ve značkách" brightgreen"," yellowgreen"," yellow"," orange"," red"," lightgray " atd. Místo "https://img.shields.io/badge/" musíte vložit adresu URL, kde je vaše jmenovka uložena.
Příklady hotových odznaků a kód, který chcete použít k vytvoření odznaků, najdete na webu shields.io. zde najdete šablony pro různé značky a zkopírujte příslušný kód do souboru README.md..
Jakmile vložíte kód do souboru README.md a uložili jej, vaše odznak by se měl zobrazit na určeném místě. Po každém sestavení projektu nebo aktualizaci metrik se také automaticky aktualizuje odznak.
Nyní máte všechny potřebné nástroje k vytvoření vlastních jmenovek na GitHub Actions a zobrazení informací o vašem projektu, které Vás zajímají. Hodně štěstí při používání odznaků!
Příklady použití odznaků na Githubu
Webová služba GitHub poskytuje možnost přidat odznaky (nebo ikony) v popisu úložiště pro zobrazení různých metadat a stavů projektu. Odznaky se často používají k zobrazení informací o stavu sestavení, pokrytí kódu testy, verze programovacího jazyka a dalších možností projektu.
Uveďme několik příkladů použití odznaků na Githubu:
- Odznaky s informacemi o stavu sestavení:
-  - zobrazuje stav sestavení na Travis CI.
-  - zobrazuje stav sestavení na CircleCI.
-  - zobrazuje stav sestavení na GitHub Actions.
- Štítky s informacemi o pokrytí kódu testy:
-  - ukazuje procento pokrytí kódu testy.
-  - ukazuje pořadí kódu projektu.
-  - ukazuje pokrytí kódu testy.
- Bajky s informacemi o verzi programovacího jazyka:
-  - zobrazuje verzi Pythonu.
-  - ukazuje verzi Ruby.
-  - zobrazuje verzi Node.js.
Takové štítky pomáhají vývojářům a uživatelům rychle vyhodnotit stav a kvalitu projektu bez nutnosti dalších kontrol a analýzy kódu. Mohou být také dalším podnětem k podpoře a dalšímu rozvoji projektu.
Tipy pro zdobení a ladění odznaků
Výběr barevného schématu
Barvy odznaků mají velký význam, protože pomáhají uživateli rychle přijímat informace. Doporučuje se zvolit světlé a kontrastní barvy, které jsou dobře viditelné na různých kulisách. Můžete také použít barvy, které odpovídají vaší značce nebo tématu projektu.
Kombinace textu a ikon
Vyhněte se používání příliš dlouhých vět nebo slov k popisu odznaku. Zkuste použít stručný a informativní text, který jasně vyjadřuje hodnotu odznaku. Nezapomeňte však, že odznaky mohou mít další odznaky, které mohou poskytnout další informace. Například ikonu "pokrok" lze použít k zobrazení aktuálního stavu sestavení nebo pokrytí kódu.
Přizpůsobení vzhledu
GitHub Actions vám umožňuje přizpůsobit vzhled odznaků pomocí stylů a možností. Můžete změnit velikost, barvu, písmo textu značky, přidat stíny nebo zaoblení rohů. To vám pomůže integrovat odznaky organičtěji do vaší dokumentace nebo úložiště.
| Parametr | Popis | Příklad |
|---|---|---|
| style | Určuje styl odznaku | style=flat |
| label | Určuje text odznaku | label=build |
| message | Identifikuje bajeovu zprávu | message=passing |
| color | Určuje barvu odznaku | color=green |
Použití různých možností a stylů může pomoci učinit odznaky atraktivnějšími a informativnějšími pro uživatele.
Použití příslušných hodnot
Pro každou charakteristiku vašeho projektu nebo úložiště vyberte příslušné hodnoty. Pokud například chcete zobrazit stav sestavení, použijte hodnoty "prochází" a "selže" místo "ano" nebo "ne". Tím se zlepší porozumění odznaku a vyhne se možným nejednoznačnostem.
V důsledku výše uvedených tipů budete moci vytvořit krásné a informativní odznaky pro váš projekt na Githubu. To pomůže uživatelům poskytnout srozumitelné a aktuální informace o vašem projektu, upoutat pozornost a zlepšit vnímání vašeho úložiště.