Kommentar zu einem Issue, wenn eine Bezeichnung hinzugefügt wird

Einführung

In diesem Tutorial wird gezeigt, wie sich mit GitHub CLI ein Sachverhalt kommentieren lässt, wenn eine bestimmte Bezeichnung angewendet wird. Wenn beispielsweise die Bezeichnung help wanted zu einem Issue hinzugefügt wird, kannst du einen Kommentar hinzufügen, um Mitwirkende zur Arbeit am Issue zu ermutigen. Weitere Informationen zur GitHub CLI findest du unter Verwenden der GitHub CLI in Workflows.

In diesem Tutorial erstellen Sie zunächst eine Workflowdatei, die mit dem Befehl gh issue comment einen Sachverhalt kommentiert. 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: Add comment
   on:
     issues:
       types:
         - labeled
   jobs:
     add-comment:
       if: github.event.label.name == 'help wanted'
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - name: Add comment
           run: gh issue comment "$NUMBER" --body "$BODY"
           env:
             GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GH_REPO: ${{ github.repository }}
             NUMBER: ${{ github.event.issue.number }}
             BODY: >
               This issue is available for anyone to work on.
               **Make sure to reference this issue in your pull request.**
               :sparkles: Thank you for your contribution! :sparkles:
   

4. Passe die Parameter in deiner Workflowdatei an:

   • Ersetze help wanted in if: github.event.label.name == 'help wanted' durch die Bezeichnung, auf die du reagieren möchtest. Wenn du auf mehr als eine Bezeichnung reagieren möchtest, trenne die Bedingungen durch ||. if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' wird beispielsweise immer dann kommentiert, wenn die Bezeichnung bug oder fix me zu einem Issue hinzugefügt wird.
   • Ändere den Wert für BODY in den Kommentar, den du hinzufügen möchtest. GitHub Flavored Markdown wird unterstützt. Weitere Informationen zum Markdown findest du unter Grundlegende Schreib- und Formatierungssyntax.

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 in deinem Repository mit einer Bezeichnung versehen wird, wird dieser Workflow ausgeführt. Wenn es sich bei der hinzugefügten Bezeichnung um eine der Bezeichnungen handelt, die Sie in der Workflowdatei angegeben haben, fügt der Befehl gh issue comment den angegebenen Kommentar zum Sachverhalt hinzu.

Teste deinen Workflow, indem du deine angegebene Bezeichnung auf ein Issue anwendest.

1. Öffne ein Issue in deinem Repository. Weitere Informationen findest du unter Einen Issue erstellen.
2. Bezeichne das Issue mit der angegebenen Bezeichnung in deiner Workflowdatei. Weitere Informationen findest du unter Verwalten von Bezeichnungen.
3. Zeige den Verlauf deiner Workflowausführungen an, um die Workflowausführung zu ermitteln, die durch das Bezeichnen des Issues ausgelöst wurde. Weitere Informationen findest du unter Anzeigen des Ausführungsverlaufs eines Workflows.
4. Wenn der Workflow abgeschlossen ist, sollte dem von dir bezeichneten Issue ein Kommentar hinzugefügt worden sein.

Nächste Schritte

• Weitere Informationen zu anderen Aktionen, die Sie mit der GitHub-CLI durchführen können, z. B. das Bearbeiten vorhandener Kommentare, finden Sie im Handbuch zu GitHub-CLI.