Erstellen von Workflowvorlagen für die Organisation

Erstellen von Workflowvorlagen

In diesem Verfahren wird das Erstellen einer Workflowvorlage und einer Metadatendatei veranschaulicht. Die Metadatendatei beschreibt, wie die Workflowvorlage Benutzer*innen beim Erstellen eines neuen Workflows zur Verfügung gestellt wird.

1. Falls es noch nicht existiert, erstellen Sie ein neues Repository .github in Ihrer Organisation.

2. Erstelle ein Verzeichnis namens workflow-templates.

3. Erstelle die neue Workflowdatei im Verzeichnis workflow-templates.

   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 Standard-Branches des Repositorys ersetzt.

   Die Datei octo-organization-ci.yml veranschaulicht beispielsweise einen grundlegenden Workflow.

   YAML

   name: Octo Organization CI
   
   on:
     push:
       branches: [ $default-branch ]
     pull_request:
       branches: [ $default-branch ]
   
   jobs:
     build:
       runs-on: ubuntu-latest
   
       steps:
         - uses: actions/checkout@v5
   
         - name: Run a one-line script
           run: echo Hello from Octo Organization
   

4. 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:

   JSON

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

   • 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. Dieser wird in der Liste der verfügbaren Workflows angezeigt.
   • iconName - Optional: Legt ein Symbol für den Workflow fest, das in der Liste der Workflows angezeigt wird. iconName kann eine der folgenden Typen sein:
     • 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. Beispiel: octicon smiley.
   • categories - Optional: 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.
     • Unterstützte Technologiestapel aus der Liste im Repository starter-workflows.
   • filePatterns - Optional: Dies ermöglicht die Verwendung des Workflows, wenn sich im Repository des Benutzers bzw. der Benutzerin eine Datei im Stammverzeichnis befindet, die einem definierten regulären Ausdruck entspricht.

5. Fügen Sie die Dateien demselben Verzeichnis workflow-templates hinzu, um eine weitere Workflowvorlage hinzuzufügen.

Nächste Schritte

• Referenzinformationen zu Workflowvorlagen findest du unter Wiederverwenden von Workflowkonfigurationen.