Schnellstart für GitHub Actions

Probieren Sie die Kernfunktionen in GitHub Actions Minuten aus.

In diesem Artikel

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, die Tests ausführen, wenn Sie eine Änderung an Ihr Repository übertragen oder zusammengeführte Pullanforderungen für die Produktion bereitstellen.

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

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

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

Verwenden von Workflowvorlagen

GitHub bietet vordefinierte Workflowvorlagen, die du unverändert übernehmen oder anpassen kannst, um einen eigenen Workflow zu erstellen. GitHub analysiert den Code und zeigt Workflowvorlagen 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.

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

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.

Voraussetzungen

In diesem Leitfaden wird davon ausgegangen, dass:

  • Sie haben mindestens ein Grundwissen über die Verwendung GitHub. Andernfalls finden Sie es hilfreich, einige der Artikel in der Dokumentation für Repositorys und Pull Requests zuerst zu lesen. Beispiele findest du unter Schnellstart für Repositorys, Branches und Pull-Anfragen.

  • Sie haben ein Repository, in GitHub dem Sie Dateien hinzufügen können.

  • Sie haben Zugriff auf GitHub Actions.

    Hinweis

    Wenn die Registerkarte "Aktionen " nicht unter dem Namen Ihres Repositorys GitHubangezeigt wird, liegt dies möglicherweise daran, dass Aktionen für das Repository deaktiviert sind. Weitere Informationen finden Sie unter Einstellung der GitHub Actions für ein Repository verwalten.

Erstellen deines ersten Workflows

  1. Erstellen Sie in Ihrem Repository im GitHubVerzeichnis eine Workflowdatei, die .github/workflows im Verzeichnis aufgerufen wirdgithub-actions-demo.yml. Gehen Sie hierzu folgendermaßen vor:

    • Wenn das Verzeichnis bereits vorhanden ist, navigieren Sie zu diesem .github/workflows Verzeichnis GitHub, klicken Sie auf "Datei hinzufügen", und 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 Hauptseite des Repositorys, GitHubklicken 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.

    Hinweis

    Um GitHub Workflows GitHub Actions in Ihrem Repository zu ermitteln, müssen Sie die Workflowdateien in einem Verzeichnis speichern, das aufgerufen wird .github/workflows.

    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@v6
      - 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 Workflowdateien in Workflows und eine Erläuterung von GitHub Actions Kontexten, z ${{ github.actor }} . B. und ${{ github.event_name }}, siehe Kontextreferenz.

  3. Klicke auf Änderungen übernehmen.

  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 übernehmen oder Änderungen vorschlagen.

    Screenshot des Dialogfelds „Änderungen vorschlagen“, in dem die erwähnten Bereiche mit einer orangefarbenen Kontur hervorgehoben sind.

Durch das Festschreiben 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 Repositorynamen auf Actions.

    Screenshot: Registerkarten für das Repository „github/docs“. Die Registerkarte „Aktionen“ ist mit einem orangefarbenen Rahmen hervorgehoben.

  3. Klicken Sie in der linken Randleiste auf den Workflow, den Sie anzeigen möchten, in diesem Beispiel "GitHub Actions Demo".

    Screenshot: Seite „Actions“. Der Name des Beispielworkflows "GitHub Actions Demo" wird durch eine dunkel orangefarbene Kontur hervorgehoben.

  4. Klicken Sie in der Liste der Workflowausführungen auf den Namen der anzuzeigenden Ausführung, in diesem Beispiel "BENUTZERNAME testet GitHub Actions".

  5. Klicken Sie auf der linken Randleiste der Workflowausführungsseite unter Jobs auf den Auftrag Explore-GitHub-Actions.

    Screenshot der Seite „Workflow-Durchlauf“. In der linken Seitenleiste wird der Job "Explore-GitHub-Actions" mit einer dunklen orangefarbenen Kontur hervorgehoben.

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

    Screenshot: Vom Workflow ausgeführte Schritte

    Beispielsweise wird die Liste der Dateien in deinem Repository angezeigt:

    Erweiterter Screenshot des Schritts „Dateien im Repository auflisten“ zur Anzeige der Protokollausgabe. Die Ausgabe für den Schritt ist mit einer orangenen Gliederung hervorgehoben.

Der soeben hinzugefügte Beispielworkflow wird jedes Mal ausgelöst, wenn Code an die Verzweigung verschoben wird, und zeigt, wie GitHub Actions Sie mit dem Inhalt Ihres Repositorys arbeiten können. Ein ausführliches Tutorial findest du unter Grundlegendes zu GitHub Actions.

Nächste Schritte

GitHub Actions kann Ihnen dabei helfen, nahezu jeden Aspekt Ihrer Anwendungsentwicklungsprozesse zu automatisieren. Willst du loslegen? Hier sind einige hilfreiche Ressourcen zum Ausführen der nächsten Schritte mit GitHub Actions: