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

Einführung

In diesem Tutorial wird gezeigt, wie du die Aktion peter-evans/create-or-update-comment verwendest, um ein Issue zu kommentieren, 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.

In diesem Tutorial erstellst du zunächst eine Workflowdatei, die die peter-evans/create-or-update-comment-Aktion 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

   # Dieser Workflow verwendet Aktionen, die nicht von GitHub zertifiziert sind.
   # Sie werden von einem Drittanbieter bereitgestellt und unterliegen
   # separaten Nutzungsbedingungen, Datenschutzbestimmungen und Support
   # Onlinedokumentation.
   
   # GitHub empfiehlt, Aktionen an einen Commit-SHA anzuheften.
   # Um eine neuere Version zu erhalten, musst du den SHA aktualisieren.
   # Du kannst auch auf ein Tag oder einen Branch verweisen, aber die Aktion kann sich ohne Vorwarnung ändern.
   
   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
           uses: peter-evans/create-or-update-comment@a35cf36e5301d70b76f316e867e7788a55a31dae
           with:
             issue-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 du in deiner Workflowdatei angegeben hast, fügt die Aktion peter-evans/create-or-update-comment den von dir angegebenen Kommentar zum Issue 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 weiteren Optionen für die Aktion peter-evans/create-or-update-comment (z. B. Hinzufügen von Reaktionen) findest du in der Dokumentation zur Aktion peter-evans/create-or-update-comment.