Mit der GitLab-Anbindung sehen Sie Merge Requests, Pipelines, Umgebungen und Commits direkt an Ihren Aufgaben in FeatValue. Ihre Kunden erfahren in einfachen Worten, ob ihre Änderung in Umsetzung, auf Staging zum Testen oder live ist.
Wofür die GitLab-Anbindung da ist
Software-Dienstleister und Webagenturen bekommen oft dieselbe Frage: „Ist das schon online?“ Mit der Anbindung beantwortet FeatValue sie an der Aufgabe:
- Branches, Commits und Merge Requests mit der Aufgaben-ID erscheinen an der passenden Aufgabe.
- Pipelines und Deployments zeigen, ob die Änderung getestet und auf welcher Umgebung sie angekommen ist.
- Wichtige Schritte schreibt FeatValue als Kommentar in den Verlauf der Aufgabe.
- Sie legen je Projekt fest, was Ihre Kunden davon sehen.
- Manuelle Jobs, zum Beispiel ein Deployment, starten Sie direkt aus FeatValue.
Einen Überblick zeigt die Seite zur GitLab-Anbindung.
Voraussetzungen
- ein FeatValue-Konto Ihres Unternehmens mit mindestens einem Kunden und Projekt (siehe Projekte anlegen)
- GitLab auf gitlab.com oder als eigene Instanz, erreichbar über https
- mindestens die Rolle Maintainer in den GitLab-Projekten, die Sie verknüpfen möchten. Damit darf FeatValue den Webhook anlegen.
GitLab verbinden
-
App öffnen
Klicken Sie in der linken Sidebar auf
Apps, wählen Sie
GitLab und klicken Sie auf
Installieren (siehe
Apps verbinden). Es erscheint die Seite
GitLab verbinden mit der Frage
Wo liegt Ihr GitLab?
-
gitlab.com
Wählen Sie gitlab.com und klicken Sie auf Weiter. Melden Sie sich bei GitLab an und erlauben Sie den Zugriff. FeatValue bekommt so Zugriff auf Ihre Projekte.
-
Eigene GitLab-Instanz
Wählen Sie Eigene GitLab-Instanz. Tragen Sie unter Adresse der Instanz die https-Adresse ein, zum Beispiel https://gitlab.example.com, und unter Personal Access Token einen Token. Klicken Sie auf Weiter.
Welchen Token brauche ich für eine eigene Instanz?
Legen Sie den Token in GitLab unter Einstellungen › Access Tokens an:
- Scope:
api. Lesende Scopes wie read_api reichen nicht, weil FeatValue Webhooks anlegt und manuelle Jobs startet.
- Rolle: Der Nutzer des Tokens braucht in den Projekten mindestens die Rolle Maintainer.
- Ablaufdatum: Läuft der Token ab, kommen keine neuen Daten mehr an. Legen Sie dann einen neuen an und verbinden Sie GitLab erneut.
Nutzen Sie für die Anbindung am besten einen eigenen Nutzer oder einen Gruppen-Token. Dann hängt sie nicht am Konto einer einzelnen Person.
Repository mit einem Projekt verknüpfen
Jedes Repository gehört fest zu einem FeatValue-Projekt. Nur verknüpfte Repositories kommen in FeatValue an.
-
Seite Repositories verknüpfen öffnen
Öffnen Sie
Einstellungen › Unternehmen › Integrationen & Apps und dort
GitLab (siehe
Verbundene Apps). Die Seite heißt
Repositories verknüpfen.
-
Repository suchen
Unter Repositories in GitLab finden Sie Ihre Repositories. Mit Repository suchen grenzen Sie die Liste ein.
-
Projekt wählen und verknüpfen
Wählen Sie neben dem Repository das FeatValue-Projekt und klicken Sie auf Verknüpfen. FeatValue legt in GitLab einen Webhook an und liest die letzten Tage nach.
Unter Verknüpfte Repositories sehen Sie alle Verknüpfungen. Die Spalte Aktualisierung zeigt Sofort per Webhook oder Alle 10 Minuten. Mit Ändern wählen Sie ein anderes Projekt, mit Trennen heben Sie die Verknüpfung auf und FeatValue entfernt den Webhook wieder.
Aufgaben-ID richtig verwenden
Jede Aufgabe in FeatValue hat eine ID, zum Beispiel abc123-4. Sie steht an der Aufgabe. Schreiben Sie diese ID an eine dieser Stellen:
| Wo |
Beispiel |
| Branch-Name |
abc123-4-kontaktformular |
| Commit-Message |
abc123-4 Telefonnummer ist Pflichtfeld |
| Titel oder Beschreibung des Merge Requests |
Kontaktformular: Telefonnummer als Pflichtfeld (abc123-4) |
- Groß- und Kleinschreibung spielt keine Rolle, ein
# davor ist erlaubt.
- Steht die ID im Branch-Namen, zählen nur die Commits, die allein auf diesem Branch liegen. Commits vom Standard-Branch, die beim Abzweigen mitkommen, erscheinen nicht an der Aufgabe.
- Commits auf anderen Branches erscheinen nur, wenn die ID in ihrer Commit-Message steht.
- Die ID gilt nur im verknüpften Projekt. Repositories, die mit einem anderen Projekt oder gar nicht verknüpft sind, ordnet FeatValue nie zu.
- Pipelines und Deployments gehören zur Aufgabe, wenn sie zu einem ihrer Branches, Commits oder Merge Requests laufen.
Was an der Aufgabe erscheint
An der Aufgabe steht der Bereich Entwicklung mit einer kompakten Zeile, zum Beispiel: MR !12 gemergt · Pipeline erfolgreich · Ausgerollt auf Staging. Mit Details anzeigen klappen Sie auf:
- Pipelines mit Stages und Jobs und ihrem Status
- Umgebungen mit Link zum Öffnen, zum Beispiel Staging und Production
- Merge Requests, Branches und Commits
Was im Projekt erscheint
Im Projekt zeigt der Bereich Entwicklung die Umgebungen mit dem letzten Deployment und die letzte Pipeline auf dem Standard-Branch. Mit Alle Pipelines anzeigen sehen Sie die Letzten Pipelines. Dort finden Sie auch die Einstellungen für das Projekt.
Was sehen Kunden?
In den Einstellungen des Bereichs Entwicklung im Projekt wählen Sie unter Was sehen Kunden?:
| Einstellung |
Ihr Kunde sieht |
| Nichts |
keine Angaben aus GitLab |
| Einfacher Stand |
einen Satz ohne technische Begriffe: In Umsetzung, Ausgerollt auf Staging mit dem Link hier testen oder Live mit dem Link jetzt ansehen |
| Details |
die Bereiche, die Sie unter Details für Kunden ankreuzen: Commits, Branches, Merge Requests, Pipelines, Umgebungen und Verlaufs-Kommentare |
Ändern dürfen die Einstellung Personen Ihres Unternehmens, die das Projekt bearbeiten dürfen. Wie Ihr Kunde danach testet und freigibt, steht unter Review und Abnahme.
Verlaufs-Kommentare einstellen
FeatValue schreibt wichtige Schritte als Kommentar in den Verlauf der Aufgabe. Unter Verlaufs-Kommentare an der Aufgabe wählen Sie je Projekt, welche Ereignisse einen Kommentar erzeugen:
- Merge Request gemergt
- Pipeline erfolgreich
- Pipeline fehlgeschlagen (mit fehlgeschlagenen Jobs)
- Ausgerollt auf Umgebung
Abgewählte Ereignisse aktualisieren weiter den Stand an der Aufgabe, erzeugen aber keinen Kommentar. Ob Ihr Kunde die Kommentare sieht, hängt von der Einstellung unter Was sehen Kunden? ab.
Jobs aus FeatValue starten
Starter
Manuelle Jobs Ihrer Pipeline, zum Beispiel deploy-production, starten Sie direkt in FeatValue. Das ist ab dem Tarif Starter möglich (siehe Pläne).
-
Jobs freigeben
Öffnen Sie im Projekt die Einstellungen des Bereichs Entwicklung. Unter Jobs aus FeatValue starten stehen die manuellen Jobs, die GitLab bisher gemeldet hat. Kreuzen Sie die Jobs an, die in FeatValue erscheinen sollen, und klicken Sie auf Speichern.
-
Auch für Kunden
Soll Ihr Kunde die gewählten Jobs selbst starten, kreuzen Sie Auch Kunden dürfen die gewählten Jobs starten an.
-
Job starten
Wartet ein freigegebener Job auf den manuellen Start, erscheint er mit dem Button Starten. Nach dem Klick zeigt FeatValue Gestartet, den weiteren Verlauf sehen Sie an der Pipeline.
Steht dort Noch keine manuellen Jobs gemeldet., ist noch keine Pipeline mit einem manuellen Job gelaufen. Sobald GitLab einen meldet, können Sie ihn freigeben.
Sicherheit
- Nur verknüpfte Repositories: FeatValue liest nur Repositories, die Sie mit einem Projekt verknüpft haben, und ordnet Aufgaben-IDs nur innerhalb dieses Projekts zu.
- Kein Code: FeatValue speichert keine Dateien aus Ihrem Repository, nur Angaben zu Branches, Commits, Merge Requests, Pipelines und Umgebungen.
- Geprüfter Webhook: Jeder Webhook bekommt ein eigenes geheimes Token. FeatValue nimmt nur Aufrufe an, die dieses Token mitsenden.
- Ihre Rechte in GitLab: FeatValue arbeitet mit den Rechten der Anmeldung oder des Tokens. Starten kann es nur Jobs, die Sie freigegeben haben.
- Jederzeit trennbar: Mit Trennen heben Sie eine Verknüpfung auf und FeatValue entfernt den Webhook.
Fehlerbehebung
Mein Repository fehlt in der Liste
FeatValue zeigt nur Repositories, in denen Sie mindestens die Rolle Maintainer haben. Prüfen Sie Ihre Rolle in GitLab oder suchen Sie mit Repository suchen nach dem Namen.
Der Webhook konnte nicht angelegt werden
Dann steht bei der Verknüpfung Alle 10 Minuten statt Sofort per Webhook. FeatValue fragt GitLab in diesem Fall alle 10 Minuten ab, es geht also nichts verloren, es kommt nur später an. Häufige Ursachen: Ihnen fehlt die Rolle Maintainer, oder Ihre GitLab-Instanz darf keine Aufrufe ins Internet senden. Prüfen Sie das und klicken Sie danach auf Ändern und erneut auf Verknüpfen.
An der Aufgabe erscheint nichts
- Ist das Repository mit dem Projekt verknüpft, in dem die Aufgabe liegt?
- Steht die Aufgaben-ID vollständig im Branch-Namen, in der Commit-Message oder im Merge Request?
- Ohne Webhook dauert es bis zu 10 Minuten, bis neue Daten ankommen.
GitLab hat den Token nicht angenommen
Prüfen Sie die Adresse der Instanz, den Token und den Scope api. Der Token darf nicht abgelaufen sein.
Ein Job lässt sich nicht starten
Jobs starten ist ab dem Tarif Starter möglich. Außerdem muss der Job in den Einstellungen des Projekts freigegeben sein und gerade auf den manuellen Start warten. Erscheint Konnte nicht gestartet werden, prüfen Sie in GitLab, ob die Anmeldung den Job noch starten darf.