Hinzufügen von Bezeichnungen zu Issues

Einführung

In diesem Tutorial wird veranschaulicht, wie du GitHub CLI in einem Workflow verwendest, um neue oder erneut geöffnete Issues zu bezeichnen. Beispielsweise kannst du jedes Mal die Bezeichnung triage hinzufügen, wenn ein Issue geöffnet oder erneut geöffnet wird. So kannst du alle Issues, die selektiert werden müssen, durch Filtern nach Issues mit der Bezeichnung triage anzeigen.

Mit GitHub CLI kannst du die GitHub-API problemlos in einem Workflow verwenden.

Im Tutorial erstellen Sie zunächst eine Workflowdatei, die die GitHub CLI verwendet. Im Anschluss passt du den Workflow an deine Anforderungen an.

Erstellen des Workflows

1. Wähle ein Repository aus, in dem du diesen Projektverwaltungsworkflow anwenden möchtest. Du kannst ein vorhandenes Repository verwenden, auf das du Schreibzugriff hast, oder du kannst ein neues Repository erstellen. Weitere Informationen zum Erstellen eines Repositorys findest du unter Ein neues Repository erstellen.

2. Erstelle in deinem Repository eine Datei namens .github/workflows/YOUR_WORKFLOW.yml, und ersetze YOUR_WORKFLOW durch einen Namen deiner Wahl. Dies ist eine Workflowdatei. Weitere Informationen zum Erstellen neuer Dateien auf GitHub findest du unter Neue Dateien erstellen.

3. Kopiere den folgenden YAML-Inhalt in deine Workflowdatei.

   YAML

   name: Label issues
   on:
     issues:
       types:
         - reopened
         - opened
   jobs:
     label_issues:
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - run: gh issue edit "$NUMBER" --add-label "$LABELS"
           env:
             GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GH_REPO: ${{ github.repository }}
             NUMBER: ${{ github.event.issue.number }}
             LABELS: triage
   

4. Passe die env-Werte in deiner Workflowdatei an:

   • Die Werte GH_TOKEN, GH_REPO, und NUMBER werden automatisch mithilfe der Kontexte github und secrets festgelegt. Du musst sie nicht ändern.
   • Ändere den Wert für LABELS in die Liste der Bezeichnungen, die du dem Issue hinzufügen möchtest. Die Bezeichnungen müssen für dein Repository vorhanden sein. Trenne mehrere Bezeichnungen durch Kommas voneinander ab. Beispiel: help wanted,good first issue. Weitere Informationen zu Bezeichnungen findest du unter Verwalten von Bezeichnungen.

5. Committe deine Workflowdatei in den Standardbranch deines Repositorys. Weitere Informationen findest du unter Neue Dateien erstellen.

Testen des Workflows

Jedes Mal, wenn ein Issue im Repository geöffnet oder erneut geöffnet wird, fügt dieser Workflow die Bezeichnungen hinzu, die du für das Issue angegeben hast.

Teste deinen Workflow, indem du ein Issue in deinem Repository erstellst.

1. Erstelle ein Issue in deinem Repository. Weitere Informationen findest du unter Einen Issue erstellen.
2. Um die Workflowausführung anzuzeigen, die durch das Erstellen des Issues ausgelöst wurde, rufe den Verlauf deiner Workflowausführungen auf. Weitere Informationen findest du unter Anzeigen des Ausführungsverlaufs eines Workflows.
3. Wenn der Workflow abgeschlossen ist, sollten dem erstellten Issue die angegebenen Bezeichnungen hinzugefügt worden sein.

Nächste Schritte

• Informationen zu weiteren Aktionen, die du mit den GitHub CLI erledigen kannst, findest du im GitHub CLI-Handbuch.
• Informationen zu den verschiedenen Ereignissen, die dein Workflow auslösen kann, findest du unter Ereignisse zum Auslösen von Workflows.
• Durchsuche GitHub nach Beispielen für Workflows, die gh issue edit verwenden.