Skip to main content

Quickstart for GitHub Actions

Try out the core features of GitHub Actions in minutes.

Introduction

GitHub Actions ist eine Plattform für Continuous Integration und Continuous Delivery (CI/CD), mit der du deine Build-, Test- und Bereitstellungspipeline automatisieren kannst. You can create workflows that run tests whenever you push a change to your repository, or that deploy merged pull requests to production.

This quickstart guide shows you how to use the user interface of GitHub to add a workflow that demonstrates some of the essential features of 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 Using workflow templates.

For an overview of GitHub Actions workflows, see Informationen zu Workflows. If you want to learn about the various components that make up GitHub Actions, see Understanding GitHub Actions.

Using workflow templates

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.

Prerequisites

This guide assumes that:

Creating your first workflow

  1. In your repository on GitHub, create a workflow file called github-actions-demo.yml in the .github/workflows directory. To do this:

    • If the .github/workflows directory already exists, navigate to that directory on GitHub, click Add file, then click Create new file, and name the file github-actions-demo.yml.

    • If your repository doesn't have a .github/workflows directory, go to the main page of the repository on GitHub, click Add file, then click Create new file, and name the file .github/workflows/github-actions-demo.yml. This creates the .github and workflows directories and the github-actions-demo.yml file in a single step.

    Hinweis

    For GitHub to discover any GitHub Actions workflows in your repository, you must save the workflow files in a directory called .github/workflows.

    You can give the workflow file any name you like, but you must use .yml or .yaml as the file name extension. YAML is a markup language that's commonly used for configuration files.

  2. Copy the following YAML contents into the github-actions-demo.yml file:

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

    At this stage you don't need to understand the details of this workflow. For now, you can just copy and paste the contents into the file. After completing this quickstart guide, you can learn about the syntax of workflow files in Informationen zu Workflows, and for an explanation of GitHub Actions contexts, such as ${{ github.actor }} and ${{ github.event_name }}, see Zugreifen auf kontextbezogene Informationen zu Workflowausführungen.

  3. Click Commit changes.

  4. In the "Propose changes" dialog, select either the option to commit to the default branch or the option to create a new branch and start a pull request. Then click Commit changes or Propose changes.

    Screenshot of the "Propose changes" dialog with the areas mentioned highlighted with an orange outline.

Committing the workflow file to a branch in your repository triggers the push event and runs your workflow.

If you chose to start a pull request, you can continue and create the pull request, but this is not necessary for the purposes of this quickstart because the commit has still been made to a branch and will trigger the new workflow.

Viewing your workflow results

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Namen deines Repositorys auf Aktionen.

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

  3. In the left sidebar, click the workflow you want to display, in this example "GitHub Actions Demo."

    Screenshot of the "Actions" page. The name of the example workflow, "GitHub Actions Demo", is highlighted by a dark orange outline.

  4. From the list of workflow runs, click the name of the run you want to see, in this example "USERNAME is testing out GitHub Actions."

  5. In the left sidebar of the workflow run page, under Jobs, click the Explore-GitHub-Actions job.

    Screenshot of the "Workflow run" page. In the left sidebar, the "Explore-GitHub-Actions" job is highlighted with a dark orange outline.

  6. The log shows you how each of the steps was processed. Expand any of the steps to view its details.

    Screenshot of steps run by the workflow.

    For example, you can see the list of files in your repository:

    Screenshot of the "List files in the repository" step expanded to show the log output. The output for the step is highlighted with an orange outline.

The example workflow you just added is triggered each time code is pushed to the branch, and shows you how GitHub Actions can work with the contents of your repository. For an in-depth tutorial, see Understanding GitHub Actions.

Next steps

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 Using workflow templates zu finden.
  • Informationen zu CI-Workflows (Continuous Integration) sind unter Building and testing zu finden.
  • Informationen zum Erstellen und Veröffentlichen von Paketen findest du unter Publishing packages.
  • Informationen zum Bereitstellen von Projekten findest du unter Use cases and examples.
  • Informationen zum Automatisieren von Aufgaben und Prozessen auf GitHub findest du unter Managing projects.
  • Beispiele, die komplexere Features von GitHub Actions veranschaulichen, sind unter Use cases and examples 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.
  • Zum Nachweis der Kenntnisse in der Automatisierung von Arbeitsabläufen und der Beschleunigung der Entwicklung mit GitHub Actions kann ein GitHub Actions-Zertifikat mit GitHub Certifications erworben werden. Weitere Informationen findest du unter Informationen zu GitHub Certifications.