Einrichtung und Konfiguration - Jira Cloud
Was diese Integration macht
Die Integration mit Jira Cloud erlaubt es dir, direkt aus der Detailansicht eines Fehlers in DockRay ein Bug-Ticket zu erstellen, ohne Meldung, Stacktrace oder Anfragepfad von Hand zu kopieren. Das Anlegen eines Tickets speichert eine dauerhafte Verknüpfung: ein DockRay-Fehler zu einem Jira-Ticket. Sobald dieses Ticket in Jira die Statuskategorie Done erreicht, markiert DockRay den Fehler selbständig als gelöst - das Lesen des Status geschieht periodisch, nicht sofort: der Befehl thor:sync-jira prüft verknüpfte Tickets alle fünf Minuten.
Was du auf Jira-Seite brauchst
- eine Jira-Cloud-Instanz in der Domain
*.atlassian.net- die Integration akzeptiert ausschließlich öffentliche HTTPS-Adressen in dieser Domain, - die E-Mail-Adresse des Atlassian-Kontos, das im Namen der Integration handelt,
- ein für dieses Konto erzeugtes API-Token (Atlassian-Kontoeinstellungen → Sicherheit → API-Token),
- ein Jira-Projekt, das die Tickets empfangen soll - die Integration bildet auf ein Projekt ab, nicht auf ein Board, denn ein Board ist nur eine Ansicht auf ein Projekt.
Verbindung auf Kontoebene
Gehe im DockRay-Panel zu Einstellungen → Jira und trage die Adresse der Instanz, die E-Mail des Atlassian-Kontos und das API-Token ein. Diese Verbindung gilt für alle Projekte des Kontos, die keine eigenen Zugangsdaten hinterlegt haben - ein einzelnes Projekt kann sie später überschreiben.
Konfiguration für ein einzelnes Projekt
Wähle in Projekteinstellungen → Jira das Jira-Projekt aus, das Tickets erhalten soll, eine Standard-Zuweisung sowie einen optionalen Startstatus. Ein DockRay-Projekt kann die Zugangsdaten des gesamten Kontos nutzen oder eigene bekommen - nützlich, wenn verschiedene Teams im Unternehmen getrennte Jira-Instanzen oder getrennte Service-Konten führen.
Was in den Ticketinhalt eingeht
Die Ticketbeschreibung ist ein Dokument im Atlassian Document Format: ein Zitat mit Fehlertyp und Meldung, eine Liste von Fakten (Projekt, Umgebung, Anfrage, Anzahl der Vorkommen, erstes und letztes Vorkommen an diesem Tag, Client-SDK), der Ort des Absturzes mit ein paar Codezeilen um die betroffene Zeile, ein gekürzter Stacktrace und ein Link zurück ins DockRay-Panel. Was in dieser Beschreibung bewusst fehlt, beschreibt der nächste Artikel.
Der erste Test
Öffne einen beliebigen vorhandenen Fehler in einem Projekt und erstelle daraus ein Jira-Ticket. Prüfe in Jira, dass das Ticket im erwarteten Projekt gelandet ist, mit einer Beschreibung, die Fehlermeldung, Absturzort und einen Link zum DockRay-Panel enthält. Beim Fehler in DockRay sollte jetzt ein Link zum erstellten Ticket erscheinen - der sichtbare Beweis, dass die Verknüpfung gespeichert wurde.