Schnellstart für GitHub Actions

Einführung

GitHub Actions ist eine Plattform für Continuous Integration und Continuous Delivery (CI/CD), mit der du deine Build-, Test- und Bereitstellungspipeline automatisieren kannst. Sie können Workflows erstellen, mit denen Sie Tests ausführen können, wenn Sie eine Änderung am Repository durchführen, oder mit denen Sie gemergte Pull Requests für die Produktion bereitstellen können.

In diesem Schnellstarthandbuch erfahren Sie, wie Sie die Benutzeroberfläche von GitHub verwenden, um einen Workflow hinzuzufügen, der einige der wesentlichen Features von GitHub Actions veranschaulicht.

Für die ersten Schritte mit vorkonfigurierten Workflows durchsuchen Sie die Liste der Vorlagen im Repository der Aktions-/Starter-Workflows. Weitere Informationen findest du unter Verwenden von Workflowvorlagen.

Eine Übersicht über die Workflows GitHub Actions finden Sie unter „Informationen zu Workflows“. Wenn Sie mehr über die verschiedenen Komponenten erfahren möchten, aus denen GitHub Actions bestehen, lesen Sie „Grundlegendes zu GitHub Actions“.

Verwenden von Workflowvorlagen

GitHub bietet vordefinierte Workflowvorlagen, die Sie unverändert übernehmen oder anpassen können, um einen eigenen Workflow zu erstellen. GitHub Enterprise Server analysiert den Code und zeigt Workflowvorlagen an, die für Ihr Repository nützlich sein könnten. Wenn Dein Repository beispielsweise Node.js-Code enthält, werden Vorschläge für Node.js-Projekte angezeigt.

Diese Workflowvorlagen ermöglichen einen schnellen Einstieg und bieten verschiedene Konfigurationen, wie z. B.:

• CI: Workflows für Continuous Integration
• Bereitstellungen: Bereitstellungsworkflows
• Automatisierung: Workflows zur Automatisierung
• Codeüberprüfung: Workflows zur Codeüberprüfung
• Seiten: Seitenworkflows

Sie können diese Workflows als Ausgangspunkt nutzen, um eigene benutzerdefinierte Workflows zu erstellen, oder sie unverändert übernehmen. Die vollständige Liste der Workflowvorlagen können Sie im Repository der Aktions-/Starter-Workflows durchsuchen. Weitere Informationen findest du unter Verwenden von Workflowvorlagen.

Voraussetzungen

In diesem Leitfaden wird davon ausgegangen, dass:

• Sie verfügen mindestens über Grundkenntnisse in der Verwendung von GitHub. Andernfalls finden Sie es hilfreich, einige der Artikel in der Dokumentation für Repositorys und Pull Requests zuerst zu lesen. Siehe z. B. "“Schnellstart für Repositorys“, „Informationen zu Branches“ und „Informationen zu Pull Requests“.

• Sie verfügen über ein Repository für GitHub, in dem Sie Dateien hinzufügen können.

• Sie haben Zugriff auf GitHub Actions.

  Note

  Wenn die Registerkarte -Aktionen nicht unter dem Namen Ihres Repositorys auf GitHub angezeigt wird, liegt dies möglicherweise daran, dass Aktionen für das Repository deaktiviert sind. Weitere Informationen findest du unter Verwalten von GitHub Actions-Einstellungen für ein Repository.

Erstellen deines ersten Workflows

1. Erstellen Sie in Ihrem Repository unter GitHub im Verzeichnis .github/workflows eine Workflow-Datei namens github-actions-demo.yml. Gehen Sie hierzu folgendermaßen vor:

   • Wenn das .github/workflows-Verzeichnis bereits vorhanden ist, navigieren Sie zu diesem Verzeichnis unter GitHub, klicken Sie auf Datei hinzufügen, klicken Sie dann auf Neue Datei erstellen und nennen Sie die Datei github-actions-demo.yml.

   • Wenn Ihr Repository nicht über ein .github/workflows-Verzeichnis verfügt, wechseln Sie zur Standardseite des Repositorys auf GitHub, klicken Sie auf Datei hinzufügen, klicken Sie dann auf Neue Datei erstellen und nennen Sie die Datei .github/workflows/github-actions-demo.yml. Dadurch werden die Verzeichnisse .github und workflows und die Datei github-actions-demo.yml in einem einzigen Schritt erstellt.

   Note

   Damit GitHub alle GitHub Actions-Workflows in Ihrem Repository ermitteln können, müssen Sie die Workflow-Dateien in einem Verzeichni namens .github/workflows speichern.

   Sie können der Workflow-Datei einen beliebigen Namen geben, aber Sie müssen als Suffix .yml oder .yaml verwenden. YAML ist eine Markupsprache, die häufig für Konfigurationsdateien verwendet wird.

2. Kopiere die folgenden YAML-Inhalte in die Datei github-actions-demo.yml:

   YAML

   name: GitHub Actions Demo
   run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
   on: [push]
   jobs:
     Explore-GitHub-Actions:
       runs-on: ubuntu-latest
       steps:
         - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
         - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
         - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
         - name: Check out repository code
           uses: actions/checkout@v4
         - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
         - run: echo "🖥️ The workflow is now ready to test your code on the runner."
         - name: List files in the repository
           run: |
             ls ${{ github.workspace }}
         - run: echo "🍏 This job's status is ${{ job.status }}."
   

   In dieser Phase müssen Sie die Details dieses Workflows nicht verstehen. Jetzt können Sie den Inhalt einfach kopieren und in die Datei einfügen. Nach Abschluss dieses Schnellstarthandbuchs erfahren Sie mehr über die Syntax von Workflow-Dateien in „Informationen zu Workflows“, und für eine Erläuterung von GitHub Actions-Kontexten, wie z. B, ${{ github.actor }} und ${{ github.event_name }} siehe „Zugreifen auf kontextbezogene Informationen zu Workflowausführungen“.

3. Klicke auf Änderungen committen.

4. Wählen Sie im Dialog "Änderungen vorschlagen" entweder die Option, in die standardmäßige Verzweigung zu übertragen oder die Option, eine neue Verzweigung zu erstellen und eine Pull-Anfrage zu starten. Klicken Sie dann auf Änderungen committen oder Änderungen vorschlagen.

   

Durch das Committen der Workflowdatei in einen Branch in deinem Repository wird das push-Ereignis ausgelöst, und dein Workflow wird ausgeführt.

Wenn Sie sich entschieden haben, einen Pull Request zu starten, können Sie den Pull Request fortsetzen und erstellen. Es ist jedoch für die Zwecke dieser Schnellstartanleitung nicht erforderlich, da der Commit noch an einer Verzweigung vorgenommen wurde und den neuen Workflow auslöst.

Anzeigen der Workflowergebnisse

1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

2. Klicke unter dem Namen deines Repositorys auf Aktionen.

   

3. Klicke auf der linken Randleiste auf den Workflow, den zu anzeigen möchtest (in diesem Beispiel „GitHub Actions Demo“).

   

4. Klicke in der Liste der Workflowausführungen auf den Namen der Ausführung, die du anzeigen möchtest (in diesem Beispiel „BENUTZERNAME testet GitHub Actions“).

5. Klicke auf der linken Randleiste der Seite für Workflowausführungen unter Aufträge auf den Auftrag Explore-GitHub-Actions.

   

6. Das Protokoll zeigt, wie die einzelnen Schritte ausgeführt wurden. Erweitere einen beliebigen Schritt, um die zugehörigen Details anzuzeigen.

   

   Beispielsweise wird die Liste der Dateien in deinem Repository angezeigt:

   

Der soeben hinzugefügte Beispielworkflow wird jedes Mal ausgelöst, wenn Code an den Branch gepusht wird, und er zeigt, wie GitHub Actions den Inhalt deines Repositorys verwenden kann. Ein ausführliches Tutorial findest du unter Grundlegendes zu GitHub Actions.

Nächste Schritte

GitHub Actions kann dir dabei helfen, nahezu alle Aspekte deines Anwendungsentwicklungsprozesses zu automatisieren. Willst du loslegen? Hier findest du einige hilfreiche Ressourcen für deine nächsten Schritte mit GitHub Actions:

• Informationen zum Erstellen eines GitHub Actions-Workflows sind unter „Verwenden von Workflowvorlagen“ zu finden.
• Informationen zu CI-Workflows (Continuous Integration) sind unter „Erstellen und Testen“ zu finden.
• Informationen zum Erstellen und Veröffentlichen von Paketen findest du unter Veröffentlichen von Paketen.
• Informationen zum Bereitstellen von Projekten findest du unter Anwendungsfälle und Beispiele.
• Informationen zum Automatisieren von Aufgaben und Prozessen auf GitHub findest du unter Projekte verwalten.
• Beispiele, die komplexere Features von GitHub Actions veranschaulichen, sind unter „Anwendungsfälle und Beispiele“ zu finden. Diese detaillierten Beispiele erläutern, wie man Code auf einem Runner testen, auf die GitHub-CLI zugreifen und erweiterte Funktionen wie Parallelität und Testmatrizen verwenden kann.