GitHub-Probleme
Beheben Sie GitHub-App-Installationsschleifen, fehlende Organisationen und Repositories, Webhook- und Berechtigungsfehler sowie Branch-Konflikte.
Die meisten Probleme mit der GitHub-Integration lassen sich auf Berechtigungen, Webhook-Fehler oder Branch-Konflikte zurückführen.
Organisation wird während der Einrichtung nicht angezeigt
Im Einrichtungsablauf der Starter-Dokumentation zeigt Jamdesk Ihre GitHub-Organisationen an, damit Sie auswählen können, wo das Repository erstellt werden soll. Die Liste stammt aus der OAuth API von GitHub. GitHub blendet Organisationen in zwei Fällen aus:
- OAuth-App-Einschränkungen: Ihre Organisation beschränkt den Zugriff von Drittanbieter-Apps (die Standardeinstellung für neue Organisationen bei GitHub) und hat Jamdesk noch nicht genehmigt.
- SAML SSO: Ihre Organisation erfordert eine SAML-Authentifizierung, bevor die API sie zurückgibt.
Wenn Sie Inhaber der Organisation sind, können Sie Jamdesk sofort genehmigen:
- Klicken Sie unter der Organisationsauswahl auf GitHub auf grant Jamdesk access on GitHub (oder gehen Sie zu GitHub → Settings → Applications → Authorized OAuth Apps → Jamdesk)
- Klicken Sie unter Organization access neben Ihrer Organisation auf Grant
- Klicken Sie im Jamdesk-Einrichtungsablauf auf refresh the list. Ihre Organisation wird sofort angezeigt
Wenn Sie Mitglied und kein Inhaber sind, wird stattdessen eine Request-Schaltfläche angezeigt. Wenn Sie darauf klicken, wird eine Genehmigungsanfrage an die Administratoren Ihrer Organisation gesendet.
Wenn Sie Mitglied ohne Inhaberrechte sind, senden Sie zunächst eine Genehmigungsanfrage an Ihre Administratoren:
- Gehen Sie zu GitHub → Settings → Applications → Authorized OAuth Apps → Jamdesk
- Klicken Sie unter Organization access neben Ihrer Organisation auf Request. Dadurch werden die Administratoren Ihrer Organisation benachrichtigt
- Ein Administrator genehmigt die Anfrage unter Settings → Third-party access → OAuth application policy der Organisation (ausstehende Anfragen zeigen eine Approve-Schaltfläche)
- Kehren Sie zum Jamdesk-Einrichtungsablauf zurück und klicken Sie auf refresh the list. Ihre Organisation sollte nun angezeigt werden
Eine ausführliche Anleitung finden Sie im GitHub-Leitfaden zum Genehmigen von OAuth-Apps für Ihre Organisation.
Möchten Sie nicht auf die Genehmigung durch einen Administrator warten? Wählen Sie während der Einrichtung Ihr persönliches Konto aus und übertragen Sie das Repository anschließend in Ihre Organisation:
- Schließen Sie die Jamdesk-Einrichtung mit Ihrem persönlichen Konto ab
- Öffnen Sie das erstellte Repository auf GitHub
- Gehen Sie zu Settings → General → Danger Zone
- Klicken Sie auf Transfer und wählen Sie Ihre Organisation als Ziel aus
- Trennen Sie in Jamdesk die Verbindung zum Repository und stellen Sie sie auf der Settings-Seite Ihres Projekts wieder her
Durch das Trennen und Wiederherstellen der Verbindung wird eine neue Dokumentations-URL erstellt (z. B. kann sich your-project.jamdesk.app ändern). Wenn Sie Ihre URL bereits weitergegeben oder eine benutzerdefinierte Domain eingerichtet haben, wenden Sie sich vor dem Trennen an den Support, damit wir Ihre Konfiguration beibehalten können.
Dies funktioniert nicht, wenn Ihr Unternehmen Ihr GitHub-Konto verwaltet. Lesen Sie stattdessen den Abschnitt Von Unternehmen verwaltete GitHub-Konten.
Von Unternehmen verwaltete GitHub-Konten
Wenn Ihr Unternehmen Ihr GitHub-Konto verwaltet (GitHub bezeichnet diese als Enterprise Managed Users oder EMU), können Sie Apps nicht auf Ihrem eigenen Konto installieren, sondern nur in einer Organisation. Wenn Ihnen keine Organisation zur Verfügung steht, gelangen Sie durch Klicken auf Install bei GitHub lediglich zurück zur Jamdesk-App-Seite. Während der Registrierung zeigt Jamdesk die Meldung „Your organization manages this GitHub account“ an.
Verwaltete Benutzernamen enden mit einem Unterstrich und einem Unternehmenskürzel, z. B. jsmith_acme. GitHub erläutert die Einschränkungen auf der Seite zu verwalteten Benutzerkonten.
Sie können dieses Problem auf zwei Arten beheben.
- Bitten Sie einen Enterprise-Inhaber, über die Registerkarte Organizations Ihres Enterprise eine Organisation zu erstellen. Bitten Sie ihn, Ihnen das Erstellen von Repositories darin zu erlauben.
- Übertragen Sie Ihr Dokumentations-Repository dorthin. Gehen Sie im Repository zu Settings, klicken Sie unten auf Transfer und wählen Sie die neue Organisation aus.
- Klicken Sie in Jamdesk auf Connect an existing repository (oder in den Projekteinstellungen auf Install GitHub App). Wählen Sie auf GitHub die Organisation aus, wählen Sie Only select repositories, markieren Sie Ihr Repository und installieren Sie die App.
Wenn GitHub statt Install die Option Request anzeigt, erhält ein Organisationsinhaber eine E-Mail zur Genehmigung. Klicken Sie anschließend erneut auf die Jamdesk-Schaltfläche.
Verwenden Sie diese Option, wenn Ihr Unternehmen keine Organisation hinzufügen kann. Klären Sie dies zuerst mit Ihrem GitHub-Administrator, da die Dokumentation außerhalb des GitHub-Kontos Ihres Unternehmens gespeichert wird.
- Melden Sie sich in einem privaten Browserfenster mit einem persönlichen Konto bei GitHub an (oder erstellen Sie eines).
- Erstellen Sie in diesem Konto ein leeres privates Repository.
- Übertragen Sie eine Kopie Ihrer Dokumentation dorthin. GitHub kann Repositories nicht aus einem verwalteten Enterprise verschieben, daher ist eine Kopie erforderlich.
git remote set-url origin https://jsmith@github.com/jsmith/product-docs.git
git push -u origin mainLassen Sie jsmith@ in der URL stehen, damit Git nach den Anmeldedaten Ihres persönlichen Kontos fragt.
- Klicken Sie in Jamdesk auf Connect an existing repository (oder in den Projekteinstellungen auf Install GitHub App), installieren Sie Jamdesk in Ihrem persönlichen Konto und wählen Sie das Repository aus.
Verwaltete Konten können keine Pushes an Repositories außerhalb Ihres Enterprise durchführen. Daher benötigt jede Person, die die Dokumentation bearbeitet, ein persönliches GitHub-Konto. Fügen Sie diese Personen als Mitbearbeiter zum Repository hinzu.
Repository wird nicht angezeigt
Wenn Ihr Repository nicht in der Liste angezeigt wird:
- Gehen Sie zu GitHub → Settings → Applications → Jamdesk
- Prüfen Sie, ob der Zugriff auf das Repository gewährt wurde
- Klicken Sie auf Configure, um weitere Repositories hinzuzufügen
Für Repositories von Organisationen gilt:
- Ein Organisationsadministrator muss Jamdesk genehmigen
- Gehen Sie zu den Organisationseinstellungen → Third-party access
- Genehmigen Sie die Zugriffsanfrage von Jamdesk
Für private Repositories ist eine Autorisierung durch GitHub erforderlich. Autorisieren Sie Jamdesk bei Bedarf erneut.
Builds werden nicht ausgelöst
Wenn Pushes keine Builds auslösen:
- Gehen Sie zu Ihrem Repository auf GitHub
- Gehen Sie zu Settings → Webhooks
- Suchen Sie den Jamdesk-Webhook
- Prüfen Sie Recent Deliveries auf Fehler
Builds werden nur für Ihren konfigurierten Branch ausgelöst. Prüfen Sie Settings in Jamdesk.
- Gehen Sie in Jamdesk zu den Settings des Projekts
- Klicken Sie auf Re-sync GitHub
Webhook-Fehler
404 Nicht gefunden
Der Webhook-Endpoint konnte nicht erreicht werden.
Lösung: Synchronisieren Sie die GitHub-Verbindung in den Projekteinstellungen erneut.
401 Nicht autorisiert
Die Authentifizierung ist fehlgeschlagen.
Lösung:
- Öffnen Sie die Einstellungen Ihres GitHub-Kontos
- Gehen Sie zu Applications → Authorized OAuth Apps
- Entziehen Sie Jamdesk die Berechtigung
- Autorisieren Sie Jamdesk in den Jamdesk-Einstellungen erneut
500 Serverfehler
Vorübergehendes Jamdesk-Problem.
Lösung: Warten Sie einige Minuten und führen Sie erneut einen Push durch oder lösen Sie einen manuellen Rebuild aus.
Berechtigungsfehler
„Repository not found“ während des Builds:
- Das Repository wurde möglicherweise gelöscht oder umbenannt
- Jamdesk hat möglicherweise den Zugriff verloren
- Autorisieren Sie Ihre GitHub-Verbindung erneut
Branch-Probleme
Falscher Branch wird erstellt
Prüfen Sie Ihren konfigurierten Branch unter Settings → Repository.
Branch umbenannt oder gelöscht
Aktualisieren Sie Ihre Branch-Einstellung so, dass sie dem neuen Branchnamen entspricht.
