GitHub-Integration

Verbinden Sie Ihr GitHub-Konto mit Ferndesk, damit Fern Ihre Codebasis durchsuchen und verstehen kann, wie Funktionen funktionieren. So können präzisere und relevantere Help-Center-Artikel erstellt werden.

Sie benötigen ein GitHub-Konto, um diese Integration abzuschließen. Falls Sie noch keines haben, erstellen Sie eines auf der GitHub-Website.

GitHub verbinden

Öffnen Sie in Ihrem Ferndesk-Dashboard in der Seitenleiste Integrationen.
Suchen Sie die GitHub-Kachel und klicken Sie auf Verbinden.
Sie werden zu GitHub weitergeleitet, um die Verbindung zu autorisieren. Melden Sie sich bei Ihrem GitHub-Konto an, falls Sie nicht bereits angemeldet sind.
Gewähren Sie Ferndesk die Berechtigung, auf Ihr GitHub-Konto zuzugreifen. Sie können auswählen, welche Repositories verbunden werden sollen. Wenn Ihr Projekt mehrere Repos umfasst, etwa ein Backend und ein Dashboard in separaten Repositories, können Sie mehrere Repositories auswählen.
Nach der Autorisierung werden Sie zurück zu Ferndesk weitergeleitet. Die GitHub-Integration wird als verbunden angezeigt.

Sobald die Verbindung hergestellt ist, kann Fern Ihre Codebasis durchsuchen, um präzisere und relevantere Help-Center-Artikel bereitzustellen.

Verbundene Repositories verwalten

Nach der ersten Einrichtung können Sie Repositories hinzufügen oder entfernen, indem Sie die Einstellungen Ihrer GitHub-App aufrufen. Gehen Sie zu den Kontoeinstellungen Ihres GitHub-Kontos, navigieren Sie zu Applications und suchen Sie Ferndesk in Ihren installierten Integrationen, um den Repository-Zugriff anzupassen.

Repository- und Branch-Einschränkung

Wenn Fern Ihre Codebasis durchsucht, kann es auf ein bestimmtes Repository oder einen bestimmten Branch aus Ihrem verbundenen GitHub-Konto zugreifen, statt sich nur auf das Standard-Repository zu verlassen.

Wenn Sie mehrere Repositories verbunden haben, kann Fern sich bei der Analyse auf das relevante Repo konzentrieren. Für branchspezifische Aufgaben, etwa die Überprüfung einer noch nicht veröffentlichten Funktion oder eines Pull Requests, kann Fern auch einen bestimmten Branch durchsuchen, wenn einer angegeben ist.

Sie können für jedes Repository auch einen Produktions-Branch festlegen, damit Fern weiß, welcher Branch Ihren Live-Code repräsentiert. Siehe unten Produktions-Branch festlegen.

Damit Fern ein Repository durchsuchen kann, stellen Sie sicher, dass es in Ihrer GitHub-Integration verbunden ist. Gehen Sie zu den Kontoeinstellungen Ihres GitHub-Kontos, navigieren Sie zu Applications und suchen Sie Ferndesk, um den Repository-Zugriff hinzuzufügen oder zu entfernen.

Produktions-Branch festlegen

Legen Sie für jedes verbundene Repository einen Produktions-Branch fest, damit Fern weiß, welcher Branch Ihren Live-Code repräsentiert. Ohne einen solchen verwendet Fern den Standard-Branch des Repositories. Jedes Repository kann einen anderen Branch verwenden.

Wählen Sie einen Produktions-Branch

Öffnen Sie Integrationen in der Seitenleiste des Dashboards und wählen Sie Ihre GitHub-Verbindung aus.
Suchen Sie auf der Detailseite der Verbindung die Karte Produktions-Branches.
Suchen Sie das Repository, das Sie konfigurieren möchten. Verwenden Sie das Suchfeld, wenn Sie viele Repositories haben.
Klicken Sie auf den Branch-Auswähler für dieses Repository und suchen Sie dann nach einem Branch oder wählen Sie einen aus der Liste aus.

Zurück zum Standard-Branch wechseln

Öffnen Sie den Branch-Auswähler und wählen Sie Standard-Branch verwenden. Fern verwendet wieder den Standard-Branch des Repositories.

Wenn Sie Fern bitten, sich einen bestimmten Branch anzusehen, etwa einen Pull-Request-Branch, hat diese Anfrage Vorrang vor der Einstellung für den Produktions-Branch.

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ählen Sie einen anderen Branch oder Standard-Branch verwenden, um fortzufahren.

Wenn GitHub Ferndesk darüber informiert, dass ein Branch gelöscht wurde, entfernt Fern die Einstellung und wechselt zurück zum Standard-Branch. Dafür muss die GitHub-App Delete-Events abonnieren.

Fehlerbehebung

Ich sehe „Authentifizierung erforderlich, um GitHub zu verbinden“

Sie müssen in Ihrem Ferndesk-Workspace angemeldet sein, bevor Sie eine Integration verbinden. Stellen Sie sicher, dass Sie angemeldet sind und sich in der richtigen Organisation befinden. Wenn Sie Zugriff auf mehrere Ferndesk-Workspaces haben, wechseln Sie zu dem Workspace, in dem Sie die GitHub-Verbindung hinzufügen möchten.

Ich sehe „Die GitHub-OAuth-Organisation stimmt nicht mit der aktiven Sitzung überein“

Das GitHub-Konto oder die Organisation, die Sie autorisieren, gehört zu einer anderen Organisation als derjenigen, bei der Sie in Ferndesk angemeldet sind. Stellen Sie sicher, dass Sie:

Im richtigen Ferndesk-Workspace angemeldet sind
Das GitHub-Konto oder die Organisation autorisieren, die zu dieser Ferndesk-Organisation gehört

Wenn Sie eine andere GitHub-Organisation mit einem anderen Ferndesk-Workspace verbinden müssen, wechseln Sie zuerst in Ferndesk zu diesem Workspace und verbinden Sie dann GitHub.

Die GitHub-Autorisierungsseite zeigt einen Fehler an

Das kann passieren, wenn:

Ihre Sitzung abgelaufen ist. Versuchen Sie, sich bei Ferndesk abzumelden und erneut anzumelden.
Der OAuth-Status ist ungültig geworden. Schließen Sie das Autorisierungsfenster und klicken Sie in Ferndesk erneut auf Verbinden.

Zusätzliche Ressourcen

Weitere Informationen zu GitHub-Funktionen finden Sie in der GitHub-Dokumentation.

War das hilfreich?