Jamdesk Documentation logo

GitHub verbinden

Verbinde dein GitHub-Repository mit Jamdesk für automatische Bereitstellungen bei Pushes – mit App-Installation, Repository-Auswahl und Branch-Konfiguration.

Jamdesk integriert sich in GitHub, um deine Dokumentation bei jedem Push von Änderungen automatisch bereitzustellen.

Die Screenshots zeigen die Benutzeroberfläche auf Englisch.

Weitere Informationen dazu, wie die GitHub App und die Verknüpfung mit einem persönlichen Konto zusammenarbeiten, findest du unter GitHub-Integration verstehen.

GitHub-App installieren

Wenn du dich zum ersten Mal bei Jamdesk anmeldest, wirst du aufgefordert, die Jamdesk GitHub App zu installieren. Diese App ermöglicht:

  • Repository-Zugriff – Inhalte deiner Dokumentation lesen
  • Webhooks – Builds bei Pushes auslösen
  • Commit-Status – Build-Status für Commits anzeigen

Berechtigungen

Die Jamdesk GitHub App fordert folgende Berechtigungen an:

BerechtigungZweck
Repository-Inhalte (Lesen)Dokumentationsdateien klonen und lesen
Metadaten (Lesen)Repositories und Branches auflisten
WebhooksPush-Benachrichtigungen empfangen

Jamdesk greift nur auf Repositories zu, für die du ausdrücklich Zugriff gewährt hast. Du kannst den Zugriff jederzeit in deinen GitHub-Einstellungen ändern.

Repository verbinden

1
Repository auswählen

Klicke beim Erstellen oder Bearbeiten eines Projekts auf Connect Repository.

Wähle ein Repository aus, in dem die GitHub App installiert ist.

2
Branch auswählen

Wähle den bereitzustellenden Branch:

  • main oder master – Am häufigsten für Produktionsdokumentation
  • docs – Wenn du deine Dokumentation in einem separaten Branch verwaltest
  • Beliebiger Branch – Für Vorschau-Bereitstellungen
3
Pfad zur Dokumentation angeben

Wenn sich deine docs.json nicht im Stammverzeichnis des Repositorys befindet, gib den Pfad an:

docs/           # Docs in a subdirectory
packages/docs/  # Monorepo with docs package

Lass das Feld leer, wenn sich docs.json im Stammverzeichnis befindet.

Nach der Verbindung zeigt dein Projekt-Dashboard das verknüpfte Repository und den Branch:

Dashboard mit verbundenem GitHub-Repository, dem Status-Badge „Linked“, dem Repository-Namen und dem Branch

Automatische Bereitstellungen

Nach der Verbindung löst jeder Push zu deinem konfigurierten Branch einen Build aus:

git add .
git commit -m "Update API documentation"
git push origin main

Builds sind in der Regel nach 30–90 Sekunden abgeschlossen. Den Status kannst du im Dashboard oder beim GitHub-Commit anzeigen.

Repositories ändern

So verbindest du ein anderes Repository:

  1. Gehe zu Settings → Repository
  2. Klicke auf Change Repository
  3. Wähle das neue Repository und den Branch aus

Das Ändern von Repositories kann sich auf deine live geschaltete Dokumentation auswirken. Das neue Repository muss eine gültige Jamdesk-Konfiguration enthalten.

Zugriff auf die GitHub App verwalten

Lege fest, auf welche Repositories Jamdesk zugreifen kann:

  1. Gehe zu github.com/settings/installations
  2. Suche Jamdesk in der Liste
  3. Klicke auf Configure
  4. Wähle unter „Repository access“ bestimmte Repositories oder alle Repositories aus

Organisations-Repositories

Bei Organisations-Repositories muss ein Organisationsadministrator die Installation der GitHub App genehmigen:

  1. Fordere die Installation über dein Jamdesk-Dashboard an
  2. Ein Administrator erhält eine Benachrichtigung in GitHub
  3. Nach der Genehmigung werden Organisations-Repositories in der Repository-Auswahl angezeigt

Persönliches Konto verknüpfen

Für eine zuverlässige Zuordnung von Builds verknüpfst du dein persönliches GitHub-Konto in User Settings:

  1. Klicke auf deinen Avatar → User Settings
  2. Suche den Abschnitt GitHub Account
  3. Klicke auf Link GitHub Account

Dies ist unabhängig von der GitHub App und stellt sicher, dass deine Commits korrekt dir zugeordnet werden. Mehr erfahren.

Fehlerbehebung

Repository wird nicht angezeigt

  • Überprüfe, ob die GitHub App im Repository installiert ist
  • Vergewissere dich bei Organisations-Repositories, dass ein Administrator den Zugriff genehmigt hat
  • Aktualisiere die Repository-Liste im Dashboard

Builds werden nicht ausgelöst

  • Überprüfe, ob der Webhook in den Repository-Einstellungen aktiv ist
  • Vergewissere dich, dass du auf den konfigurierten Branch pushst
  • Suche in GitHub nach Fehlern bei der Webhook-Zustellung

Fehler wegen verweigerter Berechtigung

  • Autorisiere die GitHub App in deinen GitHub-Einstellungen erneut
  • Stelle sicher, dass das Repository für die Jamdesk App zugänglich ist

Ausführlichere Informationen zur Fehlerbehebung findest du unter GitHub-Integration verstehen.

Wie geht es weiter?

Create a Project

Richte ein neues Jamdesk-Projekt ein

Directory Structure

Organisiere deine Dokumentation für eine skalierbare Struktur