GitHub-Anbindung

Mit der GitHub-Anbindung sehen Sie Pull Requests, Läufe von GitHub Actions, 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 GitHub-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 Pull Requests mit der Aufgaben-ID erscheinen an der passenden Aufgabe.
  • Läufe von GitHub Actions 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.
  • Fehlgeschlagene Läufe starten Sie direkt aus FeatValue neu.

Einen Überblick zeigt die Seite zur GitHub-Anbindung.

Voraussetzungen

  • ein FeatValue-Konto Ihres Unternehmens mit mindestens einem Kunden und Projekt (siehe Projekte anlegen)
  • ein Konto oder eine Organisation auf github.com
  • das Recht, Apps in diesem Konto oder dieser Organisation zu installieren. In Organisationen sind das die Owner. Andere Mitglieder können die Installation anfragen, ein Owner bestätigt sie dann in GitHub.

GitHub verbinden

  1. App öffnen

    Klicken Sie in der linken Sidebar auf Apps, wählen Sie GitHub und klicken Sie auf Installieren (siehe Apps verbinden).
  2. Mit GitHub verbinden

    Klicken Sie auf Mit GitHub verbinden. Ein kurzer Hinweis nennt die Rechte, die die App anfragt (siehe Rechte der GitHub App). Klicken Sie auf Weiter zu GitHub.
  3. Bei GitHub anmelden

    Melden Sie sich bei GitHub an und autorisieren Sie die FeatValue-App.
  4. App installieren oder Organisationen wählen

    Ist die App noch nirgends installiert, öffnet GitHub direkt die Installation: Wählen Sie Ihr Konto oder eine Organisation, dann All repositories oder unter Only select repositories die Repositories, die FeatValue sehen darf, und klicken Sie auf Install. Ist die App schon in mehreren Organisationen installiert, wählen Sie auf einer Auswahlseite die Organisationen, die Sie verbinden möchten. Danach sind Sie zurück in FeatValue.
Geben Sie nur die Repositories frei, die Sie mit FeatValue-Projekten verknüpfen möchten. Die Auswahl ändern Sie jederzeit in GitHub bei der FeatValue-App: im persönlichen Konto unter Settings › Applications › Installed GitHub Apps, in einer Organisation unter Organization settings › Third-party Access › GitHub Apps.

Rechte der GitHub App

Die FeatValue-App fragt bei GitHub diese Rechte an:

  • Metadata: read: Namen und Grunddaten der freigegebenen Repositories
  • Contents: read: Commits und Branch-Vergleiche
  • Pull requests: read: Pull Requests mit Titel, Status und Branch
  • Actions: read & write: Läufe von GitHub Actions lesen, schreibend nur für Lauf neu starten
  • Deployments: read: Deployments und Umgebungen
Die GitHub App fragt Lesezugriff auf Repository-Inhalte (Contents: read) an, weil GitHub Commits und Branch-Vergleiche nur mit diesem Recht herausgibt. FeatValue liest damit nur Commit-Daten (Message, Autor, Zeitpunkt) und Branch-Vergleiche, keinen Quellcode, und speichert keine Dateien.

Repository mit einem Projekt verknüpfen

Jedes Repository gehört fest zu einem FeatValue-Projekt. Nur verknüpfte Repositories kommen in FeatValue an.

  1. Seite Repositories verknüpfen öffnen

    Öffnen Sie Einstellungen › Unternehmen › Integrationen & Apps und dort GitHub (siehe Verbundene Apps). Die Seite heißt Repositories verknüpfen.
  2. Repository suchen

    Unter Repositories in GitHub finden Sie die Repositories, die Sie der App freigegeben haben. Mit Repository suchen grenzen Sie die Liste ein.
  3. Projekt wählen und verknüpfen

    Wählen Sie neben dem Repository das FeatValue-Projekt und klicken Sie auf Verknüpfen. FeatValue liest die letzten Tage nach. Einen Webhook müssen Sie nicht anlegen, die Ereignisse kommen über die FeatValue-App.

Unter Verknüpfte Repositories sehen Sie alle Verknüpfungen. Die Spalte Aktualisierung zeigt Sofort per Webhook. Mit Ändern wählen Sie ein anderes Projekt, mit Trennen heben Sie die Verknüpfung auf.

Mehrere Organisationen in einer Verbindung

Eine Verbindung in FeatValue nutzt die App aus allen GitHub-Organisationen und Konten, in denen sie installiert ist und auf die Sie beim Verbinden Zugriff haben, zum Beispiel Ihre eigene Organisation und die Organisationen Ihrer Kunden. Die Liste auf der Seite Repositories verknüpfen ist nach Organisation gruppiert.

  1. Organisation hinzufügen

    Öffnen Sie Einstellungen › GitHub (Seite Repositories verknüpfen) und klicken Sie auf Organisation hinzufügen.
  2. Organisation wählen

    Wählen Sie eine Organisation, in der die App schon installiert ist. Fehlt sie, klicken Sie auf In weiterer Organisation installieren und installieren Sie die App dort in GitHub.
  3. Repositories verknüpfen

    Die Repositories der Organisation erscheinen in der Liste. Verknüpfen Sie sie wie oben beschrieben.

Mehrere Unternehmen in FeatValue dürfen dieselbe Installation nutzen, zum Beispiel Ihre Agentur und Ihr Kunde mit seinem eigenen FeatValue-Konto.

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 Pull 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.
  • Läufe von GitHub Actions und Deployments gehören zur Aufgabe, wenn sie zu einem ihrer Branches, Commits oder Pull Requests laufen.

Was an der Aufgabe erscheint

An der Aufgabe steht der Bereich Entwicklung mit einer kompakten Zeile, zum Beispiel: PR #12 gemergt · Workflow erfolgreich · Ausgerollt auf Staging. Mit Details anzeigen klappen Sie auf:

  • Workflows: die Läufe von GitHub Actions, zum Beispiel CI #57, mit ihren Jobs und deren Status
  • Umgebungen aus den Deployments mit Link zum Öffnen, zum Beispiel Staging und Production
  • Pull Requests, Branches und Commits

Was im Projekt erscheint

Im Projekt zeigt der Bereich Entwicklung die Umgebungen mit dem letzten Deployment und den letzten Lauf auf dem Standard-Branch. Mit Alle Workflow-Läufe anzeigen sehen Sie die Liste Letzte Workflow-Läufe. 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 GitHub
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, Pull Requests, Workflows, 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:

  • Pull Request gemergt
  • Workflow erfolgreich
  • Workflow 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.

Fehlgeschlagene Läufe neu starten Starter

Schlägt ein Lauf von GitHub Actions fehl oder wird er abgebrochen, starten Sie ihn direkt in FeatValue neu. Bei einem fehlgeschlagenen Lauf startet GitHub nur die fehlgeschlagenen Jobs neu, bei einem abgebrochenen den ganzen Lauf. Das ist ab dem Tarif Starter möglich (siehe Pläne).

  1. Workflows freigeben

    Öffnen Sie im Projekt die Einstellungen des Bereichs Entwicklung. Unter Workflows aus FeatValue neu starten stehen die Workflows, für die GitHub bisher einen fehlgeschlagenen Lauf gemeldet hat, zum Beispiel CI. Kreuzen Sie die Workflows an, die in FeatValue erscheinen sollen, und klicken Sie auf Speichern.
  2. Auch für Kunden

    Soll Ihr Kunde die gewählten Workflows selbst neu starten, kreuzen Sie Auch Kunden dürfen die gewählten Workflows neu starten an.
  3. Lauf neu starten

    Ein fehlgeschlagener Lauf eines freigegebenen Workflows erscheint mit dem Button Neu starten. Nach dem Klick zeigt FeatValue Neu gestartet, den weiteren Verlauf sehen Sie am Lauf.

Sicherheit

  • Nur freigegebene und verknüpfte Repositories: Die FeatValue-App sieht nur die Repositories, die Sie bei der Installation freigeben. Aufgaben-IDs ordnet FeatValue nur in Repositories zu, die Sie mit einem Projekt verknüpft haben, und nur innerhalb dieses Projekts.
  • Kein Quellcode: FeatValue liest nur Commit-Daten und Branch-Vergleiche, keinen Quellcode, und speichert keine Dateien aus Ihrem Repository. Dafür fragt die App Contents: read an (siehe Rechte der GitHub App).
  • Geprüfte Webhooks: GitHub signiert jede Zustellung an FeatValue. FeatValue nimmt nur Aufrufe mit gültiger Signatur an.
  • Wenig Schreibrechte: Schreibend darf die App nur Läufe von GitHub Actions neu starten, und nur die Workflows, die Sie freigegeben haben.
  • Jederzeit trennbar: Mit Trennen heben Sie eine Verknüpfung auf. Deinstallieren Sie die App in GitHub, hebt FeatValue die Verknüpfungen der Repositories dieser Organisation automatisch auf.

Verbindung trennen und App deinstallieren

Trennen Sie die Verbindung zu GitHub in FeatValue, löscht FeatValue nur die Verknüpfungen der Repositories. Was schon an Aufgaben steht, bleibt erhalten. Die App bleibt in GitHub installiert, bis Sie sie dort deinstallieren:

  • Organisation: Öffnen Sie in GitHub Organization settings › Third-party Access › GitHub Apps, klicken Sie bei der FeatValue-App auf Configure und ganz unten auf Uninstall.
  • Persönliches Konto: Öffnen Sie Settings › Applications › Installed GitHub Apps, klicken Sie bei der FeatValue-App auf Configure und dann auf Uninstall.

Nach der Deinstallation hebt FeatValue die Verknüpfungen der Repositories dieser Organisation automatisch auf.

Fehlerbehebung

Mein Repository fehlt in der Liste

FeatValue zeigt nur Repositories, die Sie der App freigegeben haben. Öffnen Sie in GitHub Settings › Applications › Installed GitHub Apps, dort die FeatValue-App, und fügen Sie das Repository unter Repository access hinzu. Bei einer Organisation finden Sie die Einstellung in den Einstellungen der Organisation.

Die Installation wartet auf Freigabe

Sind Sie in einer Organisation kein Owner, fragt GitHub die Installation bei den Ownern an. Sobald ein Owner sie bestätigt, verbinden Sie GitHub in FeatValue erneut.

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 Pull Request?
  • Geht eine Zustellung von GitHub verloren, holt FeatValue die Daten spätestens nach 10 Minuten nach.

Ein Lauf lässt sich nicht neu starten

Neu starten ist ab dem Tarif Starter möglich. Außerdem muss der Workflow in den Einstellungen des Projekts freigegeben sein, und der Lauf muss fehlgeschlagen oder abgebrochen sein. Erscheint Konnte nicht neu gestartet werden, prüfen Sie in GitHub, ob die App noch installiert ist und das Repository sehen darf.

Eine Organisation fehlt in der Auswahl

FeatValue zeigt nur Organisationen, in denen die App installiert ist und auf die Ihr GitHub-Konto Zugriff hat. Installieren Sie die App über In weiterer Organisation installieren oder bitten Sie einen Owner der Organisation darum.

Ihre Frage wurde nicht beantwortet?

Gerne helfen wir Ihnen weiter. Sie können uns dazu eine E-Mail senden oder eine Videokonferenz vereinbaren:

Privacy Policy • Impressum • Terms and Conditions