Using workflow templates

GitHub provides workflow templates for a variety of languages and tooling.

In diesem Artikel

About workflow templates

Workflow templates are templates that help you to create your own GitHub Actions workflows for a repository. They offer an alternative to starting from a blank workflow file and are useful because some of the work will already have been done for you.

GitHub offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, GitHub analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use Node.js, GitHub will suggest a workflow template file that installs your Node.js packages and runs your tests. You can search and filter to find relevant workflow templates.

GitHub bietet einsatzbereite Workflowvorlagen für die folgenden Kategorien auf hoher Ebene:

  • Continuous Integration (CI) Weitere Informationen finden Sie unter Info zu Continuous Integration mit GitHub Actions.
  • Automatisierung. Automatisierungs-Workflowvorlagen bieten Lösungen für die Automatisierung von Workflows, wie z. B. die Triage von Pull Requests und das Anwenden einer Bezeichnung basierend auf den Pfaden, die im Pull Request geändert werden, oder das Begrüßen von Benutzern, die zum ersten Mal Mitwirkende des Repositorys sind.

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.

You can also create your own workflow template to share with your organization. These workflow templates will appear alongside the GitHub-provided workflow templates. Anyone with write access to the organization's .github repository can set up a workflow template. For more information, see Creating workflow templates for your organization.

Choosing and using a workflow template

  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. Wenn du bereits über einen Workflow im Repository verfügst, klicke auf Neuer Workflow.

  4. The "Choose a workflow" page shows a selection of recommended workflow templates. Find the workflow template that you want to use, then click Configure. To help you find the workflow template that you want, you can search for keywords or filter by category.

  5. If the workflow template contains comments detailing additional setup steps, follow these steps.

    There are guides to accompany many of the workflow templates for building and testing projects. For more information, see Building and testing.

  6. Some workflow templates use secrets. For example, ${{ secrets.npm_token }}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see Using secrets in GitHub Actions.

  7. Optionally, make additional changes. For example, you might want to change the value of on to change when the workflow runs.

  8. Click Start commit.

  9. Write a commit message and decide whether to commit directly to the default branch or to open a pull request.

Further reading