Hinweis
Auf GitHub gehostete Runner werden aktuell nicht auf GitHub Enterprise Server unterstützt.
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 das Label 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
-
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.
-
Erstelle in deinem Repository eine Datei namens
.github/workflows/YOUR_WORKFLOW.yml, und ersetzeYOUR_WORKFLOWdurch einen Namen deiner Wahl. Dies ist eine Workflowdatei. Weitere Informationen zum Erstellen neuer Dateien auf GitHub findest du unter Neue Dateien erstellen. -
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: triagename: 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 -
Passe die
env-Werte in deiner Workflowdatei an:- Die Werte
GH_TOKEN,GH_REPO, undNUMBERwerden automatisch mithilfe der Kontextegithubundsecretsfestgelegt. Du musst sie nicht ändern. - Ändere den Wert für
LABELSin die Liste der Bezeichnungen, die du dem Issue hinzufügen möchtest. Die Label(s) 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 Labels.
- Die Werte
-
Committe deine Workflowdatei in den Standardbranch deines Repositorys. Weitere Informationen finden Sie 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.
- Erstelle ein Problem in deinem Repository. Weitere Informationen finden Sie unter Ein Problem erstellen.
- Um den Workflow-Lauf anzuzeigen, der durch das Erstellen des Issues ausgelöst wurde, sieh dir den Verlauf deiner Workflow-Läufe an. Weitere Informationen finden Sie unter Anzeigen des Ausführungsverlaufs eines Workflows.
- Wenn der Workflow abgeschlossen ist, sollten dem erstellten Issue die angegebenen Labels hinzugefügt werden.
Nächste Schritte
- Weitere Informationen zu weiteren Aktionen, die Sie mit denGitHub CLI erledigen können, finden Sie im GitHub CLI-Handbuch.
- Informationen zu den verschiedenen Ereignissen, die dein Workflow auslösen kann, findest du unter Ereignisse zum Auslösen von Workflows.
-
[Durchsuchen Sie GitHub](https://github.com/search?q=path%3A.github%2Fworkflows+gh+issue+edit&type=code) für Beispiele von Workflows mit `gh issue edit`.