Connecter GitHub
Connectez votre dépôt GitHub à Jamdesk pour un déploiement automatique à chaque push : installation, choix du dépôt et de la branche.
Jamdesk s'intègre à GitHub pour déployer automatiquement votre documentation à chaque push.
Les captures d'écran montrent l'interface en anglais.
Pour en savoir plus sur la manière dont l'application GitHub et la liaison de compte personnel fonctionnent ensemble, consultez Comprendre l'intégration GitHub.
Votre documentation est plutôt dans Bitbucket Cloud ? Consultez Connecter Bitbucket. Chaque projet se connecte à un seul fournisseur.
Installation de l'application GitHub
Lors de votre première connexion à Jamdesk, vous serez invité à installer l'application GitHub Jamdesk. Cette application permet :
- Accès aux dépôts - Lire le contenu de votre documentation
- Webhooks - Déclencher des builds à chaque push
- Statut des commits - Afficher le statut du build sur les commits
Autorisations
L'application GitHub Jamdesk demande les autorisations suivantes :
| Autorisation | Objectif |
|---|---|
| Contenu du dépôt (lecture et écriture) | Cloner et lire vos fichiers de documentation. Écrit uniquement quand vous enregistrez dans l'éditeur du dashboard, acceptez des suggestions de Fix with AI ou activez la traduction |
| Métadonnées (lecture) | Lister les dépôts et les branches |
| Webhooks | Recevoir les notifications de push |
Jamdesk n'accède qu'aux dépôts pour lesquels vous accordez explicitement l'accès. Vous pouvez modifier cet accès à tout moment dans vos paramètres GitHub.
Connecter un 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 sur lesquels l'application GitHub est installée.
Sélectionnez la branche à déployer :
- main ou master - La plus courante 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 de preview
Si votre docs.json ne se trouve pas à la racine du dépôt, indiquez le chemin :
docs/ # Docs in a subdirectory
packages/docs/ # Monorepo with docs packageLaissez ce champ 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 :
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 mainLes builds se terminent généralement en 30 à 90 secondes. Suivez le statut dans le dashboard ou sur le commit GitHub.
Changer de dépôt
Pour connecter un dépôt différent :
- Accédez à Settings → Repository
- Cliquez sur Change Repository
- Sélectionnez le nouveau dépôt et la nouvelle branche
Changer de dépôt peut affecter votre documentation en ligne. Le nouveau dépôt doit contenir une configuration Jamdesk valide.
Gérer l'accès de l'application GitHub
Contrôlez les dépôts auxquels Jamdesk peut accéder :
- Accédez à github.com/settings/installations
- Recherchez Jamdesk dans la liste
- Cliquez sur Configure
- Sous « Repository access », sélectionnez des dépôts spécifiques ou tous les dépôts
Dépôts d'organisation
Pour les dépôts d'organisation, un administrateur de l'organisation doit approuver l'installation de l'application GitHub :
- Demandez l'installation depuis votre dashboard Jamdesk
- Un administrateur reçoit une notification dans GitHub
- Une fois approuvés, les dépôts de l'organisation apparaissent dans le sélecteur de dépôts
Lier votre compte personnel
Pour une attribution fiable des builds, liez votre compte GitHub personnel dans User Settings :
- Cliquez sur votre avatar → User Settings
- Recherchez la section GitHub Account
- Cliquez sur Link GitHub Account
Cette opération est distincte de l'application GitHub 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 l'application GitHub 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
GitHub vous renvoie sans cesse à la page de l'application Jamdesk
Votre entreprise gère probablement votre compte GitHub, et GitHub n'autorise pas ces comptes à installer des applications sur leur propre compte. Consultez comptes GitHub gérés par l'entreprise pour résoudre le problème.
Les builds ne se déclenchent pas
- Vérifiez que le webhook est actif dans les paramètres du dépôt
- Vérifiez que vous poussez vers la branche configurée
- Recherchez des erreurs de livraison de webhook dans GitHub
Erreurs d'autorisation refusée
- Réautorisez l'application GitHub dans vos paramètres GitHub
- Assurez-vous que le dépôt est accessible à l'application Jamdesk
Pour un dépannage plus détaillé, consultez Comprendre l'intégration GitHub.