Github-Schilde von shields.io

Github-Schilde von shields.io

24.03.2023
Shields.io ist eine Open-Source-Lösung zur schnellen Anzeige des aktuellen Projektstatus. Es wurde für GitHub-basierte Websites und offene Repositories entwickelt. Der Dienst wird auch von bekannten Projekten wie Vue.js, Bootstrap und VS Code genutzt und liefert mehr als 870 Millionen eindeutige Tags pro Monat.

Und was ist das Ziel des Projekts? Eine konsistente, einheitliche und praktische Übersicht über den Code in den Repositories zu bieten, ohne ihn auf dem eigenen Rechner durchsuchen oder klonen zu müssen. 

Shieds.io bietet eine breite Palette von Diensten an, von der kontinuierlichen Integration über soziale Netzwerke bis hin zur Codeanalyse. Der Benutzer kann also selbst entscheiden, welche Parameter seines Projekts er überwachen oder veröffentlichen möchte. 

Hintergrundinformationen 

Das 2013 gestartete Projekt b.adge.me ist der Vorläufer von shields.io. Es nutzte den Code der gh-badges-Bibliothek von Entwickler Thaddée Tyl. Die endgültige Form wurde unter dem Namen shields.io als Ergebnis zusätzlicher Innovationen und Änderungen am Projekt etabliert. Neben Tyl sind Olivier Lancan und eine große Anzahl weiterer Entwickler für die aktuelle Version verantwortlich. 

Design und Anwendung 

Es gibt einfache Design-Tags (Schilder, Badges) im SVG- und Rasterformat, die in der Projektübersicht in der README.md angezeigt werden, die auch den Tag-Code enthält. Die wesentlichen Funktionen werden dann vom Dienst selbst übernommen. Im Folgenden finden Sie eine große Auswahl der am häufigsten angefragten Informationen, die standardmäßig angeboten werden.  

Der letzte Build-Status, der Prozentsatz der Codeabdeckung durch Tests (Codeabdeckung), die Größe des Projektarchivs, die Anzahl der Downloads, die Versionsnummer, die Anzahl der erfolgreichen und fehlgeschlagenen Tests oder die Dokumentierung der verwendeten Technologien. 

Es können auch Code-Schwachstellen, Abhängigkeiten von Drittanbieter-Bibliotheken (Drittanbieter-Abhängigkeiten) oder der Grad der Anwendung allgemein anerkannter Best Practices analysiert werden. Die Tags können neben dem Link auch andere Informationen enthalten, z. B. die Anzahl der Likes, Abonnements usw. 

Weitere interessante Funktionen sind die Versionierung des GIT und die Verfolgung aller Projektaktivitäten. Sie können die Gesamtzahl der Übertragungen sowie die Anzahl der Übertragungen seit der letzten Veröffentlichung (Bereitstellung) einsehen. 

Der Monat und das Jahr der letzten Aktivität sowie das Datum der nächsten Aktivität können ebenfalls in die Markierung aufgenommen werden; dies ist besonders hilfreich, um festzustellen, ob das Projekt derzeit aktiv ist. 

Wenn Sie nichts von alledem wünschen, bietet Ihnen der Dienst auch die Möglichkeit, Ihren eigenen Tag mit individuellen Funktionen zu entwerfen und zu erstellen. 

Fazit 

Das Tagging bietet einen schnellen Überblick über die grundlegenden Elemente des Projekts und erleichtert die Untersuchung des eigenen Codes und des Codes anderer Nutzer. 

Github Shields ist ein Dienst, der aufgrund seiner visuellen Qualität und Benutzerfreundlichkeit das Potenzial hat, ein nützlicher Standard und ein beliebtes Werkzeug in der Github-Community zu werden.