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.com verwenden, um einen Workflow hinzuzufügen, der einige der wesentlichen Features von GitHub Actions veranschaulicht.

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“.

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.com, 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

Erstellen Sie in Ihrem Repository unter GitHub.com 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.

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 }}."

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 „Kontexte“.

Klicke auf Änderungen committen.
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

Navigiere auf GitHub.com zur Hauptseite des Repositorys.
Klicke unter dem Namen deines Repositorys auf Aktionen.
Klicke auf der linken Randleiste auf den Workflow, den zu anzeigen möchtest (in diesem Beispiel „GitHub Actions Demo“).
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“).
Klicke auf der linken Randleiste der Seite für Workflowausführungen unter Aufträge auf den Auftrag Explore-GitHub-Actions.
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.

Weitere Startworkflows

GitHub bietet vordefinierte Startworkflows, die du anpassen kannst, um deinen eigenen Continuous Integration-Workflow zu erstellen. GitHub analysiert deinen Code und zeigt dir CI-Startworkflows an, die für dein Repository nützlich sein könnten. Wenn Dein Repository beispielsweise Node.js-Code enthält, werden Vorschläge für Node.js-Projekte angezeigt. Du kannst Startworkflows als Ausgangspunkt verwenden, um deinen eigenen benutzerdefinierten Workflow zu erstellen, oder du kannst sie unverändert übernehmen.

Eine vollständige Liste aller Startworkflows findest du im actions/starter-workflows-Repository.

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:

Eine schnelle Möglichkeit zum Erstellen eines GitHub Actions-Workflows ist unter „Verwenden von Startworkflows“ zu finden.
Informationen zu CI-Workflows (Continuous Integration) zum Erstellen und Testen deines Codes findest du unter Automatisieren von Builds und Tests.
Informationen zum Erstellen und Veröffentlichen von Paketen findest du unter Veröffentlichen von Paketen.
Informationen zum Bereitstellen von Projekten findest du unter Bereitstellung.
Informationen zum Automatisieren von Aufgaben und Prozessen auf GitHub findest du unter Verwalten von Issues und Pull Requests.
Beispiele, die komplexere Features von GitHub Actions veranschaulichen, darunter viele der oben genannten Anwendungsfälle, findest du unter Beispiele. Du erfährst anhand detaillierter Beispiele, wie du deinen Code auf einem Runner testest, auf die GitHub-CLI zugreifst und erweiterte Funktionen wie Parallelität und Testmatrizen verwendest.
Wenn du deine Kenntnisse in der Automatisierung von Arbeitsabläufen und der Beschleunigung der Entwicklung mit GitHub Actions nachweisen möchtest, kannst du ein GitHub Actions Zertifikat mit GitHub Certifications erwerben. Weitere Informationen findest du unter Informationen zu GitHub Certifications.