Jamdesk Documentation logo

Connecter GitHub

Connectez GitHub à Jamdesk pour déployer automatiquement à chaque push. Installation de l'app, sélection du dépôt et configuration de la branche.

Jamdesk s'intègre à GitHub pour déployer automatiquement votre documentation lorsque vous poussez des modifications.

Les captures d'écran montrent l'interface en anglais.

Pour en savoir plus sur le fonctionnement de la GitHub App et de la liaison de compte personnel, consultez Comprendre l'intégration GitHub.

Installation de la GitHub App

Lors de votre première connexion à Jamdesk, vous serez invité à installer la GitHub App Jamdesk. Cette app permet :

  • Accès au dépôt - Lire le contenu de votre documentation
  • Webhooks - Déclencher des builds à chaque push
  • Statut de commit - Afficher l'état du build sur les commits

Permissions

La GitHub App Jamdesk demande ces permissions :

PermissionObjectif
Contenu du dépôt (lecture)Cloner et lire vos fichiers de documentation
Métadonnées (lecture)Lister les dépôts et les branches
WebhooksRecevoir les notifications de push

Jamdesk n'accède qu'aux dépôts auxquels vous accordez explicitement l'accès. Vous pouvez modifier l'accès à tout moment dans vos paramètres GitHub.

Connecter un dépôt

1
Sélectionner le dépôt

Lors de la création ou de la modification d'un projet, cliquez sur Connect Repository.

Choisissez parmi les dépôts où la GitHub App est installée.

2
Choisir la branche

Sélectionnez la branche à déployer :

  • main ou master - Les plus courantes pour la documentation en production
  • docs - Si vous conservez la documentation dans une branche séparée
  • N'importe quelle branche - Pour les déploiements en preview
3
Spécifier le chemin de la documentation

Si votre docs.json ne se trouve pas à la racine du dépôt, spécifiez le chemin :

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

Laissez vide si docs.json se trouve à la racine.

Une fois connecté, le dashboard de votre projet affiche le dépôt et la branche liés :

Dashboard showing GitHub repository connected with Linked status badge, repository name, and branch

Déploiements automatiques

Une fois connecté, chaque push vers votre branche configurée déclenche un build :

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

Les builds se terminent généralement en 30 à 90 secondes. Consultez le statut dans le dashboard ou sur le commit GitHub.

Changer de dépôt

Pour connecter un autre dépôt :

  1. Allez dans Settings → Repository
  2. Cliquez sur Change Repository
  3. Sélectionnez le nouveau dépôt et la branche

Changer de dépôt peut affecter votre documentation en production. Le nouveau dépôt doit contenir une configuration Jamdesk valide.

Gérer l'accès à la GitHub App

Contrôlez les dépôts auxquels Jamdesk peut accéder :

  1. Rendez-vous sur github.com/settings/installations
  2. Trouvez Jamdesk dans la liste
  3. Cliquez sur Configure
  4. Sous « Repository access », sélectionnez des dépôts spécifiques ou tous

Dépôts d'organisation

Pour les dépôts d'organisation, un administrateur de l'organisation doit approuver l'installation de la GitHub App :

  1. Demandez l'installation depuis votre dashboard Jamdesk
  2. Un administrateur reçoit une notification dans GitHub
  3. Une fois approuvés, les dépôts de l'organisation apparaissent dans le sélecteur de dépôt

Lier votre compte personnel

Pour une attribution fiable des builds, liez votre compte GitHub personnel dans User Settings :

  1. Cliquez sur votre avatar → User Settings
  2. Trouvez la section GitHub Account
  3. Cliquez sur Link GitHub Account

Cette étape est distincte de la GitHub App et garantit que vos commits vous sont correctement attribués. En savoir plus.

Dépannage

Le dépôt n'apparaît pas

  • Vérifiez que la GitHub App est installée sur le dépôt
  • Pour les dépôts d'organisation, confirmez qu'un administrateur a approuvé l'accès
  • Essayez d'actualiser la liste des dépôts dans le dashboard

Les builds ne se déclenchent pas

  • Vérifiez que le Webhook est actif dans les paramètres du dépôt
  • Assurez-vous de pousser vers la branche configurée
  • Recherchez les erreurs de livraison de Webhook dans GitHub

Erreurs de permission refusée

  • Réautorisez la GitHub App dans vos paramètres GitHub
  • Assurez-vous que le dépôt est accessible à l'app Jamdesk

Pour un dépannage plus détaillé, consultez Comprendre l'intégration GitHub.

Et ensuite ?

Créer un projet

Configurer un nouveau projet Jamdesk

Structure des répertoires

Organiser votre documentation pour passer à l'échelle