mattpocock/triage

Was macht triage?

Triage von Issues mittels eines Zustandsautomaten, der durch Triage-Rollen gesteuert wird. Verwenden, wenn der Benutzer ein Issue erstellen, triagieren, eingehende Fehler oder Feature-Anfragen überprüfen, Issues für einen AFK-Agenten vorbereiten oder den Issue-Workflow verwalten möchte.

Funktionsweise

Diese Fähigkeit verwendet einen Zustandsautomaten, um Issues durch verschiedene Phasen der Triage zu führen. Jede Phase wird durch eine bestimmte Rolle gesteuert, die definiert, welche Aktionen zulässig sind. Der Automat stellt sicher, dass Issues nur dann den nächsten Status erreichen, wenn die notwendigen Überprüfungen und Genehmigungen vorliegen.

Unterstützte Rollen

• Bug-Hunter: Erkennt und markiert potenzielle Fehler in Issues.
• Feature-Visionär: Identifiziert und bewertet Feature-Wünsche.
• Priorisierer: Ordnet Issues basierend auf Dringlichkeit und Auswirkungen Prioritäten zu.

Verwendung

Um die Fähigkeit zu nutzen, rufen Sie den entsprechenden Befehl auf:

triage <issue-id> --role <role>

Beispiel:

triage 42 --role bug-hunter

Konfiguration

Die Fähigkeit erfordert eine Konfigurationsdatei triage.config.json im Stammverzeichnis des Repositories:

{
  "roles": {
    "bug-hunter": {
      "label": "bug",
      "actions": ["mark", "comment"]
    },
    "feature-visionär": {
      "label": "feature",
      "actions": ["categorize", "request-info"]
    },
    "priorisierer": {
      "label": "priorität",
      "actions": ["assign-priority", "schedule"]
    }
  },
  "states": [
    "neu",
    "überprüft",
    "genehmigt",
    "in Bearbeitung",
    "abgeschlossen"
  ]
}

Output

Nach erfolgreicher Triage gibt die Fähigkeit ein JSON-Objekt mit dem aktualisierten Issue-Status zurück:

{
  "id": 42,
  "status": "überprüft",
  "role": "bug-hunter",
  "timestamp": "2024-01-15T10:30:00Z"
}

Fehlerbehandlung

Wenn die Eingabe ungültig ist oder die Rolle nicht autorisiert ist, wird eine Fehlermeldung ausgegeben:

Fehler: Rolle 'unbekannt' ist nicht definiert.

Hinweise

• Stellen Sie sicher, dass der GitHub-Token mit ausreichenden Berechtigungen eingerichtet ist.
• Die Fähigkeit kann in CI/CD-Pipelines integriert werden, um Issues automatisch zu triagieren.
• Verwenden Sie die Umgebungsvariable GITHUB_TOKEN zur Authentifizierung.

Weitere Informationen finden Sie in der offiziellen Dokumentation.