DevAdventCalendar · opensource · Programowanie

Badge na GitHub – shields.io

Często na GitHubie w opisach projektów można zobaczyć Badge – odznaki pokazujące status builda, pokrycia kodu, status testów i innych rzeczy. Przykładowo w repozytorium Microsoft Bot Framework SDK .NET można zobaczyć następujące badge:

Jak widać, odzwierciedlają one całkiem sporo różnych informacji.

W ramach projektu open source DevAdventCalendar również dodaliśmy różne badge:

Do wygenerowania takich odznak wykorzystaliśmy serwis shields.io.

Social media badges

Przykładowe badge np. z różnych sociali można znaleźć na stronie shields.io w kategorii social.

Kod badge dla Twittera:

[![Follow DevAdventCalendar](https://img.shields.io/twitter/follow/dev_advent_cal?label=Follow%20%40dev_advent_cal&style=social)](https://twitter.com/dev_advent_cal)

Kod badge dla Facebooka:

[![Follow DevAdventCalendar](https://img.shields.io/badge/FB-Dev%20Advent%20Calendar-blue)](https://www.facebook.com/devadventcalendar/)

Gdybyśmy chcieli dodać np. badge dotyczący GitHub forks, wystarczy kliknąć tę pozycję na liście. Zostanie wyświetlony formularz do wypełnienia:

Jak widać, mamy od razu podgląd naszego badge, dodatkowo istnieje możliwość zmiany jego stylu.

Możemy również wygenerować output o różnym formacie:

Na potrzeby GitHub wystarczy Markdown, który wyglada następująco:

![GitHub forks](https://img.shields.io/github/forks/DevAdventCalendar/DevAdventCalendar?label=Forks&style=social)

Deployment Status Badge – Azure DevOps

Potrzebujemy wstawić odpowiedni link z Azure DevOps do naszego badge dotyczącego statusu Release. Gdzie znaleźć ten link? Wystarczy, że wejdziemy w edycję konkretnego Pipeline:

A następnie wybierzemy kartę Options:

W zakładce Integrations należy zaznaczyć checkbox „Enable the deployment status badge„. Wtedy wyświetli się konkretny link do badge, który można wstawić do naszej dokumentacji.
Odpowiednia instrukcja wyświetla się również na stronie shields.io w szczegółach danego badge:

Integracja

Każda kategoria badge na shields.io umożliwia integrację z wieloma różnymi serwisami. Przykładowo wartość Code Coverage można pobrać zarówno z Azure DevOps, TeamCity, Sonar, Jenkins czy Codecov i innych:

Podsumowanie

Dodawanie badge do projektów nie jest obowiązkowe. Zachęcam jednak do dodawania różnego rodzaju badge do swoich projektów, bo dają czytelny i miły dla oka podgląd stanu aplikacji.


Podoba Ci się to, co tworzę? Chcesz dostawać informacje o:
– wydarzeniach, które organizuję lub wspieram (np. konferencje, meetupy, webinary)
– inicjatywach, które organizuję lub wspieram (np. GeekWeekWro, DevAdventCalendar)
– moich prelekcjach, kursach i szkoleniach
– wyróżnionych artykułach z mojego bloga

0% SPAMu, 100% informacji! Krótko i na temat.

Skomentuj

Wprowadź swoje dane lub kliknij jedną z tych ikon, aby się zalogować:

Logo WordPress.com

Komentujesz korzystając z konta WordPress.com. Wyloguj /  Zmień )

Zdjęcie na Google

Komentujesz korzystając z konta Google. Wyloguj /  Zmień )

Zdjęcie z Twittera

Komentujesz korzystając z konta Twitter. Wyloguj /  Zmień )

Zdjęcie na Facebooku

Komentujesz korzystając z konta Facebook. Wyloguj /  Zmień )

Połączenie z %s