Übung: Erstellen und Ausführen eines einfachen Workflows

  • 6 Minuten

Wichtig

Sie benötigen für diese Übung ein eigenes Azure-Abonnement. Außerdem fallen möglicherweise Gebühren für Sie an. Wenn Sie noch kein Azure-Abonnement besitzen, können Sie ein kostenloses Konto erstellen, bevor Sie beginnen.

Sie möchten die Bereitstellung von Updates für die Website Ihres Spielwarenunternehmens automatisieren. Als ersten Schritt erstellen Sie in GitHub Actions einen einfachen Workflow.

In dieser Übung führen Sie die folgenden Schritte aus:

  • Erstellen eines GitHub-Kontos und -Repositorys
  • Erstellen eines einfachen Workflows
  • Ausführen Ihres einfachen Workflows

Erstellen eines Repositorys in GitHub

  1. Wechseln Sie in einem Browser zu GitHub. Melden Sie sich mit Ihrem GitHub-Konto an, oder erstellen Sie ein neues Konto, falls Sie noch keins besitzen.

  2. Klicken Sie auf das Pluszeichen (+) in der oberen rechten Ecke des Fensters, und wählen Sie dann Neues Repository aus.

    Screenshot of the GitHub interface that shows the menu for creating a new repository.

  3. Geben Sie die Details Ihres neuen Repositorys ein:

    • Besitzer: Wählen Sie im Dropdownmenü Ihren GitHub-Benutzernamen aus. Im Screenshot ist mygithubuser der GitHub-Kontoname des Repositorybesitzers. Sie benötigen Ihren Kontonamen später in diesem Modul.
    • Repositoryname: Geben Sie einen aussagekräftigen, aber kurzen Namen ein. Verwenden Sie für dieses Modul toy-website-workflow.
    • Beschreibung: Fügen Sie eine Beschreibung ein, damit andere Benutzer*innen nachvollziehen können, wofür das Repository vorgesehen ist.
    • Privat: Sie können GitHub verwenden, um öffentliche und private Repositorys zu erstellen. Erstellen Sie ein privates Repository, weil nur Personen in Ihrer Organisation auf die Dateien Ihrer Toy-Website zugreifen sollten. Sie können anderen Personen später Zugriff gewähren.

    Wenn Sie fertig sind, sollte Ihre Repositorykonfiguration wie der folgende Screenshot aussehen:

    Screenshot of the GitHub interface showing the configuration for the repository to create.

  4. Klicken Sie auf Create repository (Repository erstellen).

Klonen des Repositorys

Klonen Sie Ihr Repository in Visual Studio Code.

  1. Wählen Sie auf der Repositoryseite die Schaltfläche zum Kopieren aus, um die URL in Ihr Git-Repository zu kopieren.

    Screenshot of the GitHub interface showing the new empty repository, with the repository URL copy button highlighted.

  2. Öffnen Sie Visual Studio Code.

  3. Öffnen Sie in Visual Studio Code ein neues Terminalfenster, indem Sie auf Terminal>Neues Terminal klicken. Das Fenster wird in der Regel am unteren Bildschirmrand geöffnet.

  4. Navigieren Sie im Terminal zu dem Verzeichnis, in dem Sie das GitHub-Repository auf Ihrem lokalen Computer klonen möchten. Führen Sie beispielsweise den folgenden Befehl aus, um das Repository in den Ordner toy-website-workflow zu klonen:

    cd toy-website-workflow

  5. Geben Sie git clone ein, und fügen Sie die zuvor kopierte URL ein. Das Ergebnis sollte in etwa wie folgt aussehen:

    git clone https://github.com/mygithubuser/toy-website-workflow

    Sie erhalten eine Warnung, dass Sie ein leeres Repository geklont haben. Sie können die Meldung ignorieren.

  6. Dies ist das erste Mal, dass Sie dieses Repository verwendet haben, sodass Sie möglicherweise aufgefordert werden, sich anzumelden.

    Geben Sie unter Windows 1 ein, um sich über einen Webbrowser zu authentifizieren, und drücken Sie die EINGABETASTE.

    Wählen Sie unter macOS Authorize (Autorisieren) aus.

  7. Ein Browserfenster wird geöffnet. Möglicherweise müssen Sie sich erneut bei GitHub anmelden. Wählen Sie Autorisieren.

  8. Öffnen Sie Visual Studio Code erneut im Repositoryordner, indem Sie den folgenden Befehl ausführen:

    code -r toy-website-workflow

Tipp

Sie können Ihre GitHub Actions-Workflowdefinitionen auch auf der GitHub-Webbenutzeroberfläche bearbeiten. Wenn Sie eine Workflowdefinition öffnen, unterstützt GitHub Sie bei der Syntax der YAML-Datei und beim Einzug. Außerdem stellt es Beispielcodeausschnitte für die Aktionen bereit, die Sie verwenden möchten. In diesem Modul werden Sie mit der Definitionsdatei in Visual Studio Code arbeiten, aber Sie können auch den GitHub-Editor erkunden, um herauszufinden, wie er funktioniert.

Erstellen einer YAML-Workflowdefinition

Nachdem Sie Ihr Repository erstellt und geklont haben, können Sie nun eine einfache Workflowdefinition erstellen.

  1. Öffnen Sie in Visual Studio Code den Explorer.

  2. Erstellen Sie im Stamm Ihrer toy-website-workflow-Ordnerstruktur einen neuen Ordner namens .github.

    Hinweis

    Schließen Sie unbedingt den Punkt am Anfang des Ordnernamens ein. Er gibt an, dass es sich um einen ausgeblendeten Ordner handelt. Außerdem benötigt GitHub den Punkt für GitHub Actions, um die Workflowdefinition zu erkennen.

  3. Erstellen Sie im Ordner .github einen weiteren Ordner mit dem Namen workflows.

  4. Erstellen Sie im Ordner workflows eine neue Datei mit dem Namen workflow.yml.

    Screenshot of the Visual Studio Code Explorer, with the .github/workflows folder and the workflow.yml file shown.

  5. Kopieren Sie die folgende Workflowdefinition in die Datei:

    name: deploy-toy-website

on: [workflow_dispatch]

jobs:
  say-hello:
    runs-on: ubuntu-latest
    steps:
      - name: 'placeholder step'
        run: echo "Hello world!"

  6. Speichern Sie die Datei .

  7. Committen und puschen Sie die Datei mithilfe der folgenden Befehle in Ihr GitHub-Repository:

    git add .
git commit -m "Add initial workflow definition"
git push

Tipp

Visual Studio Code unterstützt Sie beim Einzug in Ihrer YAML-Datei. Suchen Sie nach Wellenlinien, die Syntaxfehler angeben, oder wählen Sie Ansicht>Probleme aus, um eine Liste der Probleme in Ihrer Datei anzuzeigen.

Ausführen des Workflows

Sie haben eine Workflowdefinition erstellt. GitHub Actions erkennt Ihre Workflowdatei automatisch, da sie sich im Verzeichnis .github/workflows befindet.

  1. Navigieren Sie im Browser zu Ihrem Repository. Möglicherweise müssen Sie die Seite aktualisieren, damit Ihre Änderungen angezeigt werden.

  2. Klicken Sie auf die Registerkarte Actions (Aktionen).

    Screenshot of the GitHub interface showing the repository page, and the Actions tab highlighted.

  3. Wählen Sie den Workflow deploy-toy-website aus.

    Screenshot of the GitHub interface showing the Actions tab, with the deploy-toy-website workflow selected.

  4. Wählen Sie die Dropdownliste Workflow ausführen aus, und klicken Sie auf die Schaltfläche Workflow ausführen.

    Screenshot of the GitHub interface showing the Actions tab, with the Run workflow dropdown and button selected.

  5. Der Workflow beginnt mit der Ausführung. Es kann ein paar Augenblicke dauern, und Sie können die Seite aktualisieren, aber sie sollte automatisch aktualisiert werden und Ihnen eine in der Warteschlange stehende oder laufende oder sogar bereits beendete Workflowausführung anzeigen.

    Screenshot of the GitHub interface showing the Actions tab, with one workflow running.

    Beachten Sie, dass der Ausführungsstatus anfänglich als In Warteschlange angezeigt wird. Es kann einige Zeit dauern, bis Ihr Workflow gestartet wird. Ihr Auftrag wird einer Warteschlange für einen Runner hinzugefügt, und sobald ein Runner verfügbar ist, weist GitHub Actions den Runner zu und startet den Auftrag. Der Auftragsstatus wird dann in Wird ausgeführt geändert.

    Jede Workflowausführung enthält einen Bezeichner. Diesen Bezeichner können Sie verwenden, wenn Sie auf die Workflowausführung verweisen müssen und um eine bestimmte Workflowausführung zu finden.

Überprüfen der Workflowausführung

  1. Wählen Sie nach dem Start der Workflowausführung deploy-toy-website aus, um die zugehörigen Details anzuzeigen. Aktualisieren Sie die Seite, bis als Auftragsstatus Erfolg angezeigt wird.

    Screenshot of the GitHub interface showing the details of the workflow run, with the status and commit identifier highlighted.

    Beachten Sie außerdem, dass die Seite einen Bezeichner für den Git-Commit enthält, den die Ausführung verwendet hat. Der Bezeichner der Übergabe gibt an, welche Version des Inhalts Ihres Repositorys der Workflow verwendet hat.

  2. Wählen Sie in der Auftragsliste say-hello aus.

    Screenshot of the GitHub interface showing the run details menu, with the say-hello job highlighted.

  3. Die Seite mit den Auftragsinformationen wird mit dem Protokoll der Schritte angezeigt, die der Workflow für Sie ausgeführt hat. Beachten Sie, dass Ihr Platzhalterschritt enthalten ist.

    Screenshot of the GitHub interface showing the workflow run log, with the placeholder step highlighted.

    Beachten Sie, dass die Liste Schritte enthält, die Sie nicht angegeben haben. Diese Schritte werden automatisch von GitHub Actions erstellt.

  4. Wählen Sie Platzhalterschritt aus.

    Screenshot of the GitHub interface showing the workflow run log, with the placeholder step log shown.

    Die Protokolle für diesen Schritt enthalten den Inhalt des Befehls (wie in der YAML-Datei Ihres Workflows angegeben) und den Text Hello World!, den das Skript ausgegeben hat.

Es empfiehlt sich zu wissen, wie Sie einen Querverweis von einer Workflowausführung auf den darin enthaltenen Commit erstellen. Das Verknüpfen der Workflowausführung mit einem Commit kann Ihnen helfen, den Verlauf Ihrer Bereitstellungen nachzuverfolgen und Probleme zu diagnostizieren.

  1. Wählen Sie Zusammenfassung aus, um zur Zusammenfassung der Ausführung zurückzukehren.

  2. Wählen Sie den Bezeichner des Commits aus. GitHub zeigt Details zu dem Commit an, der die Workflowauslösung ausgelöst hat.