Übung: Hinzufügen eines Buildbadges

  • 7 Minuten

Es ist wichtig, dass Teammitglieder den Buildstatus kennen. Eine einfache Möglichkeit, den Buildstatus schnell zu ermitteln, besteht darin, der Datei README.md auf GitHub einen Buildbadge hinzuzufügen. Kehren wir zum Team zurück, um uns die Vorgehensweise dabei anzusehen.

Andy sitzt an seinem Schreibtisch und sichtet seine E-Mails. Er beantwortet die dritte E-Mail, die sich auf den Status des Builds für die Space Game-Website bezieht.

Andy: Es muss doch eine Möglichkeit geben, eine Statusmeldung zu automatisieren. Wir haben die Pipeline, also sollten wir in der Lage sein, irgendwo einen Status festzulegen. Vielleicht weiß Mara, wie das geht.

Andy findet Mara im Pausenraum im Gespräch mit Amita.

Andy: Hallo Amita. Was dagegen, wenn ich mir Mara mal kurz ausleihe?

Amita: Ich muss sowieso zu einem Meeting. Mach nur.

Mara: Hallo Andy. Was gibt's?

Andy: Mir gefallen die Änderungen sehr gut, die wir an unserer Buildpipeline durch die Verwendung von Azure Pipelines vorgenommen haben, und Git ist ein großartiges Versionskontrollsystem. Ich frage mich, ob es eine Möglichkeit gibt, Entwickler über den Status des Builds zu informieren?

Mara: Ja, tatsächlich. Wir können einen Buildbadge verwenden.

Was ist ein Buildbadge?

Ein Badge ist Teil von Microsoft Azure Pipelines. Er bietet Methoden, mit denen Sie ein SVG-Bild hinzufügen können, das den Status des Builds in Ihrem GitHub-Repository anzeigt.

Die meisten GitHub-Repositorys enthalten eine Datei namens README.md. Hierbei handelt es sich um eine Markdowndatei, die wichtige Details und Dokumentation zu Ihrem Projekt enthält. GitHub rendert diese Datei auf der Startseite Ihres Projekts.

Im Folgenden finden Sie ein Beispiel für einen Buildbadge:

Ein Screenshot von GitHub, der den Buildbadge zeigt. Der Status gibt an, dass der letzte Build erfolgreich war.

Für diese Übung machen Sie Ihren Buildbadge für jedermann sichtbar. Dies ist möglicherweise keine gute Idee für Ihre privaten Projekte, da Ihre Buildinformationen für die Öffentlichkeit zugänglich gemacht werden.

So prüfen Sie, ob Ihr Buildbadge sichtbar ist:

  1. Navigieren Sie in Azure DevOps zu Ihrer Organisation.

  2. Wählen Sie in der unteren Ecke Organization settings (Organisationseinstellungen) aus.

  3. Wählen Sie unter Pipelines die Option Settings (Einstellungen) aus.

  4. Deaktivieren Sie Disable anonymous access to badges (Anonymen Zugriff auf Badges deaktivieren).

    Screenshot von Azure DevOps, der zeigt, wie der anonyme Zugriff auf Badges deaktiviert wird.

Sie müssen eine ähnliche Änderung an Ihrem Projekt vornehmen:

  1. Wechseln Sie zu Ihrem Projekt.
  2. Navigieren Sie in die untere Ecke zu Projekteinstellungen.
  3. Wählen Sie unter Pipelines die Option Settings (Einstellungen) aus.
  4. Deaktivieren Sie Disable anonymous access to badges (Anonymen Zugriff auf Badges deaktivieren).

Hinzufügen des Buildbadges

Bis jetzt haben Sie Git-Branches lokal erstellt, um Änderungen am Space Game-Projekt vorzunehmen. Sie können auch direkt über GitHub Änderungen vorschlagen. In diesem Abschnitt gehen Sie so vor, um Ihren Statusbadge einzurichten.

  1. Wählen Sie in Azure DevOps im linken Bereich Pipelines aus, wählen Sie dann Ihre Pipeline aus.

  2. Wählen Sie die Auslassungspunkte (...) oben rechts aus, und wählen Sie dann Statussignalaus.

    Screenshot von Azure Pipelines mit dem Menü „Optionen“ zum Festlegen des Buildbadges.

  3. Wählen Sie unter Sample Markdows (Beispielmarkdown) die Schaltfläche Copy (Kopieren) aus, um den Markdowncode in die Zwischenablage zu kopieren.

  4. Navigieren Sie in GitHub zu Ihrem Projekt.

  5. Stellen Sie sicher, dass Sie sich im main-Branch befinden. Öffnen Sie im Dateibereich die Datei README.md.

  6. Wählen Sie Diese Datei bearbeiten (das Bleistiftsymbol) aus, um die Datei im Editor zu öffnen.

  7. Fügen Sie am oberen Rand der Seite eine leere Zeile hinzu, und fügen Sie dann den Inhalt der Zwischenablage ein.

  8. Wählen Sie die Registerkarte Vorschau aus, um die vorgeschlagenen Änderungen anzuzeigen.

    GitHub rendert die Markdowndatei und zeigt den Buildbadge an.

    Ein Screenshot von GitHub, der die Vorschau eines Buildbadges zeigt.

Committen der Änderungen in Main

In diesem Abschnitt committen Sie Ihre Änderungen am main-Branch auf GitHub.

  1. Wählen Sie Commit changes (Änderungen committen) aus.

  2. Geben Sie im Bereich Nachricht committen eine Commitnachricht an, z. B. „Build-Badge hinzufügen“.

    Screenshot von GitHub, der die Commitmeldung zeigt.

  3. Lassen Sie die Option Commit directly to the main branch (Direkt im Mainbranch committen) ausgewählt, klicken Sie dann auf Commit changes (Änderungen committen), um Ihre Änderungen an den main-Branch zu committen.

    Ihr Badge wird auf der Seite README.md angezeigt.

    Screenshot des finalen Buildbadges, so wie er auf der Seite README angezeigt wird.

    Dies ist eine einfache Möglichkeit, Code in GitHub zusammenzuführen. Anstatt direkt zu committen, hätten Sie auch einen Pull Request erstellen können, damit andere Ihre Änderungen überprüfen können.

    In der Praxis navigieren Sie zum main-Branch und pullen die neuesten Änderungen aus GitHub, wenn Sie das nächste Mal ein Feature hinzufügen oder einen Fehler beheben müssen.

Andy: Mara, Du hast gerade eine Änderung direkt an main vorgenommen. Warum hast Du nicht den Ablauf verwendet, den Du mir gezeigt hast? Also den Ablauf mit den Featurebranches.

Mara: Das hätten wir tun können. Aber manchmal, wenn Entwickler nur die README-Datei oder andere Dokumentationsdateien ändern, committen sie direkt in main. Außerdem konnten wir beide die Arbeit gemeinsam verifizieren, bevor wir die Änderung zusammengeführt haben.

Aber das bringt einen guten Punkt zur Sprache. Wenn wir alle nur in main committen, wenn wir dies möchten, könnten wir Probleme im Code in unseren main-Branch übernehmen.

Andy: Darüber wollte ich mit Dir reden.

Andy und Mara setzen dieses Gespräch fort, während sie zurück in ihre Büros gehen.