GitHub Actions ist ein großartiges Tool, mit dem Sie verschiedene Aufgaben in Ihrem Repository automatisieren können. Eine der nützlichsten Funktionen von Actions besteht darin, Abzeichen zu erstellen und anzuzeigen – kleine grafische Elemente, die über den Status Ihres Projekts informieren.
Abzeichen können für verschiedene Zwecke verwendet werden, von der Bezeichnung des Buildstatus oder der Prüfung bis zur Anzeige der aktuellen Version Ihrer Anwendung. Das Erstellen von Abzeichen mit GitHub Actions ist sehr einfach und unkompliziert, selbst für Anfänger im CI/CD-Bereich.
In diesem Leitfaden lernen wir die grundlegenden Schritte kennen, die zum Erstellen und Konfigurieren von Abzeichen mit GitHub Actions erforderlich sind. Wir werden die Syntax der YAML-Datei verstehen, lernen, die Namensschilder zu konfigurieren und sie zur Seite Ihres Projekts hinzuzufügen. Bereit zu beginnen? Lassen Sie uns beginnen, diese einfache, aber sehr nützliche Fähigkeit zu erlernen!
Verwenden von Abzeichen auf GitHub
Um ein Abzeichen auf Ihrer Projektseite auf GitHub hinzuzufügen, können Sie eine spezielle HTML-Tag-Syntax verwenden . Die Bildadresse ist ein Link zum Status des Abzeichen, der Informationen zum Status des Projekts enthält.
In diesem Beispiel wird ein Abzeichen mit dem Text "build" angezeigt: passing" auf grünem Hintergrund, was darauf hindeutet, dass die Zusammenstellung des Projekts erfolgreich abgeschlossen wurde.
Sie können dem Link auch Parameter hinzufügen, um das Aussehen des Ausweises anzupassen:
- label: legt den Text fest, der auf dem Abzeichen angezeigt wird;
- message: legt den Text fest, der neben dem Abzeichen angezeigt wird;
- color: legt die Hintergrundfarbe für das Abzeichen fest.
Eine große Auswahl an Abzeichen und spezielle Dienste zum Erstellen und Anpassen von Abzeichen helfen Ihnen, Ihre Projektseite informativer und attraktiver zu gestalten.
Jetzt wissen Sie, wie Sie Abzeichen auf GitHub hinzufügen, um Informationen über den Status eines Projekts anzuzeigen und darauf aufmerksam zu machen.
Was sind Abzeichen und warum werden sie benötigt
Abzeichen werden häufig verwendet, um verschiedene Metriken oder Projektzustände anzuzeigen, z. B.: die Softwareversion, der Build-Status, die Codeabdeckung durch Tests, die Anzahl der Abhängigkeiten usw. ermöglichen Ihnen, schnell und übersichtlich Informationen über das Projekt zu erhalten, und erhöhen die Attraktivität und das professionelle Erscheinungsbild des Projekts.
Um ein Abzeichen zu erstellen, müssen Sie nur spezielle Dienste verwenden, die Vorlagen für verschiedene Arten von Abzeichen bereitstellen und automatisch Code generieren, um sie auf der Website oder in der README einzufügen. Solche Dienste unterstützen normalerweise eine Vielzahl von Plattformen und Tools, einschließlich GitHub Actions.
Abzeichen sind ein praktisches Werkzeug zur Visualisierung verschiedener Projektmetriken und -status. Sie helfen Entwicklern und Benutzern, schnell Informationen über das Projekt zu erhalten, und motivieren Sie, ein hohes Maß an Qualität und Produktivität beizubehalten.
Vorteile der Verwendung von Abzeichen in einem Projekt
- Aufmerksamkeit erregen: Abzeichen können helle und attraktive Elemente sein, die sofort die Aufmerksamkeit der Benutzer auf Ihr Projekt lenken.
- Aussagekraft: Abzeichen können verschiedene Informationen zum Projektstatus bereitstellen, z. B. den Build-Status, die Testabdeckung, das letzte Commit und andere Metriken.
- Professionalismus: Die Verwendung von Abzeichen in einem Projekt kann einen Eindruck von Professionalität und ernsthafter Einstellung zur Entwicklung vermitteln. Sie können als Beweis dafür dienen, dass sich Ihr Projekt in aktiver Entwicklung befindet und die besten Entwicklungspraktiken befolgt.
- Bequemlichkeit: Namensschilder bieten eine schnelle und einfache Möglichkeit, Projektinformationen anzuzeigen, ohne viel Text eingeben zu müssen. Sie nehmen nur wenig Platz ein und ermöglichen die Bereitstellung von Informationen in einer übersichtlichen und kompakten Form.
- Verbesserung der Benutzerakzeptanz: Namensschilder können Benutzern helfen, Ihr Projekt besser zu verstehen und zu bewerten. Beispielsweise kann die Verwendung von Baugruppenstatus-Abzeichen Benutzern helfen zu verstehen, wie zuverlässig und stabil Ihr Projekt ist.
Im Allgemeinen kann die Verwendung von Abzeichen in einem Projekt Ihnen helfen, die visuelle Darstellung Ihres Projekts zu verbessern, den Benutzern nützliche Informationen bereitzustellen und mehr Aufmerksamkeit auf Ihre Arbeit zu lenken.
Anleitung zum Erstellen von Abzeichen auf GitHub Actions
Um ein Abzeichen zu erstellen, müssen Sie Ihrer Datei einen speziellen Code hinzufügen README.md Dazu benötigen Sie Kenntnisse der Markdown-Syntax. Zuerst müssen Sie entscheiden, welche Informationen auf Ihrem Abzeichen angezeigt werden. GitHub Actions bietet viele Optionen, zum Beispiel:
- Baugruppenstatus: wie erfolgreich war die Erstellung Ihres Projekts
- Aktueller Build: informationen zum aktuellen Build des Projekts
- Testabdeckung: zeigt den Prozentsatz der Testabdeckung Ihres Projekts an
- Anzahl der Sterne: zeigt die Anzahl der Sterne an, die Ihr Projekt erzielt hat
Code zum Erstellen von Abzeichen in einer Datei README.md hat folgendes Aussehen:
Hier können Sie anstelle von "Text" den gewünschten Ausweistext und anstelle von "Value" den Wert angeben, den Sie anzeigen möchten (z. B. den Prozentsatz der Testabdeckung). Anstelle von "Color" können Sie den Farbcode oder den Farbnamen in den Tags "brightgreen", "yellowgreen", "yellow", "orange", "red", "lightgray" usw. angeben. Statt "https://img.shields.io/badge /" Sie müssen die URL einfügen, in der Ihr Abzeichen gespeichert ist.
Beispiele für vorgefertigte Abzeichen und den Code, den Sie zum Erstellen von Abzeichen verwenden möchten, finden Sie auf der Website shields.io . Hier finden Sie Vorlagen für verschiedene Abzeichen und kopieren den entsprechenden Code in Ihre Datei README.md .
Nachdem Sie den Code in die Datei eingefügt haben README.md und wenn Sie es gespeichert haben, sollte Ihr Abzeichen an der angegebenen Stelle angezeigt werden. Jedes Mal, wenn Sie ein Projekt erstellen oder die Metriken aktualisieren, wird das Abzeichen automatisch aktualisiert.
Jetzt haben Sie alle Werkzeuge, die Sie benötigen, um Ihre eigenen Namensschilder auf GitHub Actions zu erstellen und die Informationen, die Sie über Ihr Projekt interessieren, anzuzeigen. Viel Glück mit den Abzeichen!
Beispiele für die Verwendung von Abzeichen auf GitHub
Der GitHub-Webdienst bietet die Möglichkeit, der Repository-Beschreibung Abzeichen (oder Symbole) hinzuzufügen, um verschiedene Metadaten und Projektzustände anzuzeigen. Abzeichen werden häufig verwendet, um Informationen über den Build-Status, die Codeabdeckung durch Tests, die Version der Programmiersprache und andere Projektparameter anzuzeigen.
Hier sind einige Beispiele für die Verwendung von Abzeichen auf GitHub:
- Abzeichen mit Baugruppenstatusinformationen:
-  - Zeigt den Build-Status auf Travis CI an.
-  - Zeigt den Baugruppenstatus auf dem CircleCI an.
-  - Zeigt den Build-Status auf GitHub Actions an.
- Abzeichen mit Informationen zur Codeabdeckung durch Tests:
-  - Zeigt den Prozentsatz der Codeabdeckung durch Tests an.
-  - Zeigt die Bewertung des Projektcodes an.
-  - zeigt die Codeabdeckung durch Tests an.
- Abzeichen mit Versionsinformationen der Programmiersprache:
-  - zeigt die Python-Version an.
-  - zeigt die Ruby-Version an.
-  - Zeigt die Node-Version an.js.
Diese Namensschilder helfen Entwicklern und Benutzern, den Status und die Qualität eines Projekts schnell zu bewerten, ohne dass zusätzliche Überprüfungen und Codeanalysen erforderlich sind. Sie können auch ein zusätzlicher Anreiz sein, das Projekt zu unterstützen und weiterzuentwickeln.
Tipps zum Entwerfen und Einrichten von Abzeichen
Auswählen eines Farbschemas
Die Farben der Abzeichen sind von großer Bedeutung, da sie dem Benutzer helfen, Informationen schnell wahrzunehmen. Es wird empfohlen, helle und kontrastreiche Farben zu wählen, die auf verschiedenen Hintergründen gut sichtbar sind. Sie können auch Farben verwenden, die Ihrer Marke oder Ihrem Projektthema entsprechen.
Kombination aus Text und Symbolen
Vermeiden Sie es, zu lange Sätze oder Wörter zu verwenden, um das Abzeichen zu beschreiben. Versuchen Sie, einen kurzen und informativen Text zu verwenden, der die Bedeutung des Ausweises deutlich vermittelt. Vergessen Sie jedoch nicht, dass Abzeichen zusätzliche Abzeichen haben können, die zusätzliche Informationen liefern können. Beispielsweise kann das Fortschrittssymbol verwendet werden, um den aktuellen Build-Status oder die Codeabdeckung anzuzeigen.
Anpassen des Aussehens
Mit GitHub Actions können Sie das Aussehen von Abzeichen mithilfe von Stilen und Parametern anpassen. Sie können die Größe, Farbe, Schriftart des Namensschildtextes ändern, Schatten hinzufügen oder Ecken abrunden. Dies wird Ihnen helfen, die Namensschilder organischer in Ihre Dokumentation oder Ihr Repository zu integrieren.
| Parameter | Die Beschreibung | Ein Beispiel |
|---|---|---|
| style | Definiert den Stil des Ausweises | style=flat |
| label | Definiert den Text des Ausweises | label=build |
| message | Definiert eine Abzeichen-Nachricht | message=passing |
| color | Gibt die Farbe des Ausweises an | color=green |
Die Anwendung verschiedener Parameter und Stile kann dazu beitragen, dass Abzeichen für Benutzer attraktiver und informativer werden.
Verwenden der entsprechenden Werte
Wählen Sie für jedes Merkmal Ihres Projekts oder Repositorys die entsprechenden Werte aus. Wenn Sie beispielsweise den Build-Status anzeigen möchten, verwenden Sie die Werte "Übergeben" und "fehlgeschlagen" anstelle von "Ja" oder "Nein". Dies verbessert das Verständnis des Badge und vermeidet mögliche Mehrdeutigkeiten.
Wenn Sie den oben genannten Tipps folgen, können Sie schöne und informative Namensschilder für Ihr Projekt auf GitHub erstellen. Dies wird Ihnen helfen, den Benutzern verständliche und aktuelle Informationen über Ihr Projekt zu geben, Aufmerksamkeit zu erregen und die Wahrnehmung Ihres Repositorys zu verbessern.
