Du musst bei deinem Ferndesk-Arbeitsbereich angemeldet sein, bevor du eine Integration verbindest. Stelle sicher, dass du angemeldet bist und dich in der richtigen Organisation befindest. Wenn du Zugriff auf mehrere Ferndesk-Arbeitsbereiche hast, wechsle zu dem Arbeitsbereich, in dem du die GitHub-Verbindung hinzufügen möchtest.
GitHub-Integration
Verbinde dein GitHub-Konto mit Ferndesk, damit Fern deine Codebasis durchsuchen und verstehen kann, wie Funktionen funktionieren. Dadurch können genauere und relevantere Hilfeartikel generiert werden.
Du benötigst ein GitHub-Konto, um diese Integration abzuschließen. Falls du noch keines hast, erstelle eines auf der GitHub-Website.
GitHub verbinden
Klicke in deinem Ferndesk-Dashboard in der Seitenleiste auf Integrationen.
Klicke nach dem Öffnen von „Integrationen“ auf Erstes Tool verbinden, Integration verbinden oder Alle durchsuchen, suche anschließend nach GitHub und klicke auf Verbinden.
Du wirst zur Autorisierung der Verbindung zu GitHub weitergeleitet. Melde dich bei deinem GitHub-Konto an, falls du noch nicht angemeldet bist.
Erteile Ferndesk die Berechtigung, auf dein GitHub-Konto zuzugreifen. Du kannst auswählen, welche Repositories verbunden werden sollen. Du kannst mehrere Repositories auswählen, wenn sich dein Projekt über mehrere Repositories erstreckt, beispielsweise ein Backend und ein Dashboard in getrennten Repositories.
Nach der Autorisierung wirst du zurück zu Ferndesk weitergeleitet. Die GitHub-Integration wird als verbunden angezeigt.
Sobald die Verbindung hergestellt ist, kann Fern deine Codebasis durchsuchen und genauere und relevantere Hilfeartikel bereitstellen.
GitHub-Verbindung wiederverwenden
Wenn du mehrere Ferndesk-Arbeitsbereiche verwaltest, die dieselbe GitHub-Installation verwenden, kannst du eine bestehende GitHub-Verbindung aus einem anderen Arbeitsbereich wiederverwenden, anstatt sie erneut zu autorisieren. Inhaber und Administratoren können eine Verbindung aus einem von ihnen verwalteten Arbeitsbereich wiederverwenden.
Wähle im Dialog zur GitHub-Verbindung GitHub-Verbindung wiederverwenden aus.
Wähle eine Verbindung aus einem anderen von dir verwalteten Arbeitsbereich aus. Wiederverwendbare Verbindungen sind nach GitHub-Installation gruppiert. Verbindungen, die bereits mit diesem Arbeitsbereich verknüpft sind, können nicht ausgewählt werden. Die ausgewählte Verbindung zeigt die Arbeitsbereiche an, die sie verwenden.
Nachdem du eine Verbindung wiederverwendet hast, werden ihre aktuellen Repositories in diesem Arbeitsbereich zunächst ignoriert, damit du deine eigenen Repositories auswählen kannst, bevor Fern den Code verwendet. Andere Arbeitsbereiche behalten ihre eigenen Repository-Einstellungen bei.
Verbundene Repositories verwalten
Welche Repositories Fern verwendet, wird in Ferndesk für jeden Arbeitsbereich separat festgelegt. Öffne Integrationen in der Seitenleiste des Dashboards, wähle deine GitHub-Verbindung aus und suche den Abschnitt Repositories.
Markiere jedes Repository für den aktuellen Arbeitsbereich als Eingeschlossen oder als ignoriert. Die Einstellung wird automatisch gespeichert, und neue Repositories werden automatisch eingeschlossen.
Ignorierte Repositories werden für diesen Arbeitsbereich von Ferns Coder recherche und der zukünftigen Verarbeitung von Codeänderungen ausgeschlossen.
Diese Auswahl ist unabhängig von den Repositories, auf die die GitHub-Installation zugreifen kann und die du direkt in GitHub verwaltest. Wenn du ein Repository in Ferndesk als ignoriert markierst, ändert dies nicht den Zugriff der GitHub-Installation darauf.
Repository- und Branch-Einschränkung
Wenn Fern deine Codebasis durchsucht, kann es ein bestimmtes Repository oder einen bestimmten Branch aus deinem verbundenen GitHub-Konto ansteuern, anstatt sich ausschließlich auf das Standard-Repository zu verlassen.
Wenn mehrere Repositories verbunden sind, kann Fern sich während der Analyse auf das relevante Repository konzentrieren. Für branchspezifische Aufgaben, beispielsweise die Überprüfung einer noch nicht veröffentlichten Funktion oder eines Pull Requests, kann Fern auch einen bestimmten Branch durchsuchen, wenn einer angegeben ist.
Du kannst außerdem für jedes Repository einen Produktions-Branch festlegen, damit Fern weiß, welcher Branch deinen Live-Code enthält. Siehe unten Produktions-Branch festlegen.
Damit Fern ein Repository durchsuchen kann, markiere es im Abschnitt „Repositories“ deiner GitHub-Verbindung als Eingeschlossen. Nur eingeschlossene Repositories werden von Fern in diesem Arbeitsbereich verwendet.
Produktions-Branch festlegen
Lege für jedes eingeschlossene Repository einen Produktions-Branch fest, damit Fern weiß, welcher Branch deinen Live-Code enthält. Ohne diese Einstellung verwendet Fern den Standard-Branch des Repositorys. Jedes eingeschlossene Repository kann einen anderen Branch verwenden, und Änderungen am Branch werden automatisch gespeichert.
Produktions-Branch auswählen
Öffne Integrationen in der Seitenleiste des Dashboards und wähle deine GitHub-Verbindung aus.
Suche auf der Detailseite der Verbindung den Abschnitt Repositories.
Suche das Repository, das du konfigurieren möchtest. Verwende das Suchfeld, wenn du viele Repositories hast.
Klicke für dieses Repository auf die Branch-Auswahl und suche anschließend nach einem Branch oder wähle einen aus der Liste aus.
Zum Standard-Branch zurückwechseln
Öffne die Branch-Auswahl und wähle Standard-Branch verwenden aus. Fern verwendet dann wieder den Standard-Branch des Repositorys.
Produktions-Branches beeinflussen, wie Fern GitHub-Merges verarbeitet. Für die Coder recherche verwendet Fern den Standard-Branch des Repositorys, sofern deine Anfrage keinen bestimmten Branch enthält.
Wenn ein konfigurierter Branch nicht mehr existiert
Wenn ein Produktions-Branch auf GitHub gelöscht oder umbenannt wird, weist die Karte „Produktions-Branches“ darauf hin, dass der Branch nicht mehr existiert. Wähle einen anderen Branch aus oder wähle Standard-Branch verwenden, um fortzufahren.
Wenn GitHub Ferndesk darüber informiert, dass ein Branch gelöscht wurde, entfernt Fern die Einstellung und verwendet wieder den Standard-Branch. Dafür muss die GitHub-App Delete-Ereignisse abonnieren.
Fehlerbehebung
Ich sehe „Authentifizierung erforderlich, um GitHub zu verbinden“
Ich sehe „Die GitHub-OAuth-Organisation stimmt nicht mit der aktiven Sitzung überein“
Das GitHub-Konto oder die Organisation, die du autorisierst, gehört zu einer anderen Organisation als derjenigen, bei der du in Ferndesk angemeldet bist. Stelle sicher, dass du:
beim richtigen Ferndesk-Arbeitsbereich angemeldet bist
das GitHub-Konto oder die Organisation autorisierst, die zu dieser Ferndesk-Organisation gehört
Wenn du eine andere GitHub-Organisation mit einem anderen Ferndesk-Arbeitsbereich verbinden musst, wechsle zuerst in Ferndesk zu diesem Arbeitsbereich und verbinde dann GitHub.
Auf der GitHub-Autorisierungsseite wird ein Fehler angezeigt
Dies kann folgende Ursachen haben:
Deine Sitzung ist abgelaufen. Melde dich bei Ferndesk ab und anschließend wieder an.
Der OAuth-Status ist ungültig geworden. Schließe das Autorisierungsfenster und klicke in Ferndesk erneut auf „Verbinden“.
Weitere Ressourcen
Weitere Informationen zu GitHub-Funktionen findest du in der GitHub-Dokumentation.