Creating starter workflows for your organization

In diesem Verfahren wird veranschaulicht, wie du einen Startworkflow und eine Metadatendatei erstellen kannst.

Die Metadatendatei beschreibt, wie der Startworklow Benutzer*innen beim Erstellen eines neuen Workflows zur Verfügung gestellt wird.

Wenn diese noch nicht vorhanden ist, solltest du ein neues Repository mit dem Namen .github in deiner Organisation erstellen. Erstelle ein Verzeichnis namens workflow-templates.

Erstelle die neue Workflowdatei im Verzeichnis workflow-templates.

name: Octo Organization CI

on:
  push:
    branches: [ $default-branch ]
  pull_request:
    branches: [ $default-branch ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Run a one-line script
        run: echo Hello from Octo Organization

Wenn du auf den Standardbranch eines Repositorys verweisen musst, kannst du den Platzhalter $default-branch verwenden. Beim Erstellen eines Workflows wird der Platzhalter automatisch durch den Namen des Standardbranches des Repositorys ersetzt. Die Datei octo-organization-ci.yml veranschaulicht beispielsweise einen grundlegenden Workflow.

{
    "name": "Octo Organization Workflow",
    "description": "Octo Organization CI starter workflow.",
    "iconName": "example-icon",
    "categories": [
        "Go"
    ],
    "filePatterns": [
        "package.json$",
        "^Dockerfile",
        ".*\\.md$"
    ]
}

• Erstelle im Verzeichnis workflow-templates eine Metadatendatei. Die Metadatendatei muss denselben Namen wie die Workflowdatei tragen, aber statt der .yml-Erweiterung muss .properties.json angefügt sein. Beispielsweise enthält die Datei octo-organization-ci.properties.json die Metadatei für den Workflow octo-organization-ci.yml:

• name - Muss angegeben werden. Der Name des Workflows. Dieser wird in der Liste der verfügbaren Workflows angezeigt.

• description - Muss angegeben werden. Die Beschreibung des Workflows. Diese wird in der Liste der verfügbaren Workflows angezeigt.

  • iconName - Kann optional angegeben werden. Legt ein Symbol für den Workflow fest, das in der Liste der Workflows angezeigt wird. iconName kann einem der folgenden Typen entsprechen:
  • Eine SVG-Datei, die im Verzeichnis workflow-templates gespeichert ist. Um auf eine Datei zu verweisen, muss der Wert dem Dateinamen ohne Dateierweiterung entsprechen. Beispielsweise wird auf eine SVG-Datei mit dem Namen example-icon.svg als example-icon verwiesen.

• Ein Symbol aus der Octicon-Gruppe von GitHub. Um auf ein Octicon zu verweisen, muss der Wert octicon <icon name> lauten. Beispielsweise octicon smiley.

  • categories - Kann optional angegeben werden.
  • Definiert die Kategorien, unter denen der Workflow angezeigt wird.
  • Du kannst Kategorienamen aus den folgenden Listen verwenden:

• Allgemeine Kategorienamen aus dem Repository starter-workflows. Linguist-Sprachen aus der Liste im Repository linguist.