IBM Cloud Docs
JIRA konfigurieren

JIRA konfigurieren

JIRA ist ein Tool, das Probleme und Bugs verfolgt, die mit Ihrer Software zusammenhängen. Die JIRA-Toolintegration führt eine Aktualisierung der projektbezogenen Probleme durch, wann immer Jenkins oder Delivery Pipeline eine Bereitstellung ausführen.

Damit die JIRA-Toolintegration Ihre Probleme verfolgen kann, müssen Sie in Ihren Commit-Nachrichten Smart Commits von JIRA verwenden. Um mehr über JIRA Smart Commits zu erfahren, lesen Sie den Abschnitt Smart Commits verwenden.

Konfigurieren Sie JIRA für die Planung, Verfolgung und Übermittlung von Qualitätscode. Gehen Sie dazu wie folgt vor:

  1. Wenn Sie diese Toolintegration konfigurieren, während Sie die Toolchain erstellen, klicken Sie im Abschnitt mit den konfigurierbaren Integrationen auf JIRA.

  2. Wenn Sie eine Toolchain haben und diese Toolintegration hinzufügen möchten, klicken Sie in der IBM Cloud auf das Hamburger-Symbol im Menü > Plattformautomatisierung > Toolchains. Klicken Sie auf der Seite 'Toolchains' auf die Toolchain, um die zugehörige Übersichtsseite zu öffnen. Alternativ können Sie auf der Übersichtsseite Ihrer App auf der Karte für Continuous Delivery auf Toolchain anzeigen klicken. Klicken Sie anschließend auf Übersicht.

    a. Klicken Sie auf Tool hinzufügen.

    b. Klicken Sie im Abschnitt mit den Toolintegrationen auf JIRA.

  3. Wenn Sie bereits über ein JIRA-Projekt verfügen und eine Verbindung zu ihm herstellen möchten, klicken Sie beim JIRA-Typ auf Vorhanden:

    a. Geben Sie den JIRA-Projektschlüssel für das JIRA-Projekt ein. Den Projektschlüssel können Sie der URL des JIRA-Projekts entnehmen.

    b. Geben Sie die API-Basis-URL für Ihre JIRA-Instanz ein. Die API-URL können Sie dem Header Ihrer JIRA-Instanz entnehmen. Klicken Sie auf das Symbol für Administration und klicken Sie dann auf System.

    c. Wenn Sie eine Verbindung zu einer privaten JIRA-Instanz herstellen oder Verfolgbarkeitsinformationen von einer öffentlichen JIRA-Instanz erhalten möchten, geben Sie Ihren JIRA-Benutzernamen und das Kennwort ein.

    d. Wenn Sie die Bereitstellung von Codeänderungen für das Projekt durch Erstellen von Bezeichnungen und Kommentaren für referenzierte Probleme verfolgen wollen, wählen Sie das Kontrollkästchen Bereitstellung von Codeänderungen verfolgen aus. Stellen Sie sicher, dass Sie JIRA Smart Commit beim Referenzieren der JIRA-Probleme in Ihren GitHub-Commits verwenden. Wenn Sie diese Option nicht auswählen, ignoriert die JIRA-Toolintegration alle Commits.

  4. Wenn Sie ein JIRA-Projekt erstellen möchten, klicken Sie beim JIRA-Typ auf Neu und gehen Sie wie folgt vor:

    a. Geben Sie einen JIRA-Projektschlüssel ein, der für das neue Projekt verwendet werden soll. Dieser Schlüssel fungiert als eindeutige ID in der Projekt-URL.

    b. Geben Sie einen Namen für das JIRA-Projekt ein.

    c. Geben Sie die API-Basis-URL für Ihre JIRA-Instanz ein. Die API-URL können Sie dem Header Ihrer JIRA-Instanz entnehmen. Klicken Sie auf das Symbol für Administration und klicken Sie dann auf System.

    d. Geben Sie den Benutzernamen für den JIRA-Projektleiter ein, den Sie für dieses Projekt einsetzen möchten. Um eine Person als JIRA-Projektleiter angeben zu können, muss diese in JIRA über die Projektleitungsgenehmigung verfügen.

    e. Geben Sie den Administratorbenutzernamen für diese JIRA-Instanz ein.

    Fa. Geben Sie das Administratorkennwort für diese JIRA-Instanz ein.

    g. Wenn Sie die Bereitstellung von Codeänderungen für das Projekt durch Erstellen von Bezeichnungen und Kommentaren für referenzierte Probleme verfolgen wollen, wählen Sie das Kontrollkästchen Bereitstellung von Codeänderungen verfolgen aus. Stellen Sie sicher, dass Sie JIRA Smart Commit beim Referenzieren der JIRA-Probleme in Ihren GitHub-Commits verwenden. Wenn Sie diese Option nicht auswählen, ignoriert die JIRA-Toolintegration alle Commits.

  5. Klicken Sie auf Integration erstellen.

  6. Klicken Sie auf der Übersichtsseite der Toolchain auf der Karte Tools anderer Anbieter auf JIRA, um das Dashboard für das JIRA-Projekt anzuzeigen, mit dem Sie verbunden sind.

JIRA über die API konfigurieren

Die JIRA-Toolintegration unterstützt die folgenden Konfigurationsparameter, die Sie mit der Toolchain-HTTP-API und den SDKs verwenden können, wenn Sie Toolintegrationen erstellen, lesenund aktualisieren.

Sie müssen die Eigenschaft tool_type_id im Anforderungshauptteil mit dem Wert jira angeben.

JIRA-Werkzeug-Integrationsparameter
Parameter Verwendung Typ Terraform-Argument Beschreibung
API_URL erforderlich, aktualisierbar Zeichenfolge API_URL Die Basis-API-URL für Ihre JIRA-Instanz.
enable_traceability optional, aktualisierbar, ' Default: false Boolesch enable_traceability Verfolgen Sie den Einsatz von Codeänderungen, indem Sie Tags, Labels und Kommentare zu Commits, Pull Requests und referenzierten Issues erstellen.
Kennwort Optional, aktualisierbar Kennwort API-Token Das API-Token für Ihr JIRA-Konto. Optional für öffentliche Projekte. Für diesen Parameter können Sie eine Referenz auf einen geheimen Toolchain-Schlüssel verwenden. Weitere Informationen finden Sie unter Schützen Ihrer sensiblen Daten in Continuous Delivery.
Projektschlüssel erforderlich, aktualisierbar Zeichenfolge Projektschlüssel Der Projektschlüssel Ihres JIRA-Projekts.
Benutzername Optional, aktualisierbar Zeichenfolge Benutzername Der Benutzername für Ihren JIRA-Account. Optional für öffentliche Projekte.