Intégration GitHub
Jamdesk utilise deux connexions GitHub : une GitHub App pour l'accès au dépôt et une liaison de compte personnel pour l'attribution des builds.
Jamdesk utilise deux connexions GitHub distinctes, chacune ayant un rôle différent. Cette page explique ce que fait chaque connexion et quand vous en avez besoin.
En bref : La GitHub App donne à Jamdesk l'accès à votre dépôt. Lier votre compte personnel garantit que vos commits vous sont attribués.
Vue d'ensemble
| Connexion | Objectif | Portée | Requis ? |
|---|---|---|---|
| GitHub App | Accès au dépôt et webhooks | Par projet | Oui |
| Compte personnel | Identité utilisateur et attribution | Par utilisateur | Recommandé |
GitHub App (niveau projet)
La GitHub App Jamdesk est installée sur votre compte GitHub ou votre organisation. Elle accorde à Jamdesk la permission d'accéder à des dépôts spécifiques.
Ce qu'elle fait
- Lit le contenu du dépôt - Clone vos docs pour les builder
- Reçoit les webhooks - Est notifiée lorsque vous poussez des modifications
- Signale le statut du build - Affiche le statut de déploiement sur les commits
Pourquoi vous en avez besoin
Sans la GitHub App installée, Jamdesk ne peut pas :
- Accéder à votre dépôt pour builder la documentation
- Déployer automatiquement lorsque vous poussez des modifications
- Afficher le statut du build sur les commits GitHub
Comment ça marche
Lorsque vous configurez un projet, Jamdesk vous guide dans la connexion à GitHub. Il existe deux parcours.
Créer un dépôt de docs de démarrage (par défaut pour les nouveaux projets)
Autorisez Jamdesk afin qu'il puisse créer un dépôt sur votre compte ou votre organisation.
Choisissez votre compte personnel ou une organisation. Jamdesk crée un nouveau dépôt pré-rempli avec une documentation de démarrage.
Installez la GitHub App Jamdesk (ou accordez-lui l'accès au nouveau dépôt) afin qu'elle puisse builder et déployer automatiquement vos docs.
Chaque push vers votre branche configurée déclenche automatiquement un déploiement. Personnalisez les docs de démarrage quand vous le souhaitez.
Connecter un dépôt existant
Vous avez déjà un dépôt de documentation ? Installez la GitHub App Jamdesk, accordez-lui l'accès à ce dépôt, puis choisissez le dépôt et la branche dans Jamdesk sous Paramètres du projet → Dépôt Git. À partir de là, le fonctionnement est identique.
Une seule app, plusieurs projets
Une seule installation de GitHub App peut alimenter plusieurs projets Jamdesk :
- Installez l'app une seule fois sur votre compte ou votre organisation
- Connectez différents dépôts à différents projets Jamdesk
- Chaque projet a sa propre configuration de branche et de chemin
Pour les organisations, un administrateur n'a besoin d'installer la GitHub App qu'une seule fois. Ensuite, n'importe quel membre de l'équipe peut créer des projets Jamdesk en utilisant les dépôts auxquels l'app a accès.
Compte GitHub personnel (niveau utilisateur)
Lier votre compte GitHub personnel associe votre identité GitHub à votre profil Jamdesk. Ceci est distinct de la GitHub App.
Ce qu'il fait
- Vous identifie - Associe votre nom d'utilisateur GitHub à votre compte Jamdesk
- Attribue les builds - Indique qui a déclenché chaque déploiement
- Visibilité d'équipe - Les autres membres de l'équipe peuvent voir qui a effectué les modifications
Pourquoi vous en avez besoin
Lorsque vous poussez vers GitHub, Jamdesk doit déterminer quel utilisateur a déclenché le build. Sans votre compte lié :
- Jamdesk se rabat sur une correspondance par adresse e-mail
- Si votre e-mail de commit Git diffère de votre e-mail Jamdesk, l'attribution échoue
- L'historique des builds peut afficher « Utilisateur inconnu » pour vos commits
Problème courant : Votre Git est configuré avec une adresse e-mail personnelle, mais vous vous êtes inscrit à Jamdesk avec une adresse e-mail professionnelle. Liez votre compte GitHub pour garantir une attribution correcte.
Vérifier votre e-mail Git
git config user.email
git config --global user.email "you@company.com"Utilisez la même adresse e-mail que celle qui apparaît sur votre compte Jamdesk pour éviter l'attribution « Utilisateur inconnu » dans l'historique des builds.
Comment lier votre compte
Cliquez sur votre avatar en haut à droite, puis sélectionnez Paramètres utilisateur.
Faites défiler jusqu'à la carte Compte GitHub.
Une fenêtre pop-up s'ouvre vers GitHub. Autorisez Jamdesk à lire votre profil.
Votre nom d'utilisateur GitHub apparaît dans votre profil Jamdesk.
Comment elles fonctionnent ensemble
Considérez-les comme deux clés distinctes :
| Clé | Ouvre | Détenue par |
|---|---|---|
| GitHub App | Accès aux dépôts | Projet/Organisation |
| Liaison personnelle | Votre identité | Utilisateur individuel |
Exemple d'équipe
Prenons une équipe de 3 développeurs travaillant sur la documentation de l'entreprise :
- L'administrateur installe la GitHub App sur l'organisation
- L'administrateur crée un projet Jamdesk connecté au dépôt de docs
- Chaque développeur lie son compte personnel
Désormais, lorsqu'un développeur pousse des modifications :
- La GitHub App permet à Jamdesk de lire le dépôt et de builder
- La liaison personnelle identifie qui a déclenché le build
Exemple de développeur solo
Même en tant que développeur solo, les deux connexions ont des rôles différents :
- GitHub App - Connecte votre dépôt à Jamdesk
- Liaison personnelle - Garantit que vos commits affichent votre nom dans l'historique des builds
Déconnexion et déliaison
Chaque action supprime un élément d'accès différent. Voici ce que chacune affecte.
Déconnecter GitHub (Paramètres du projet)
Ce que ça fait : Supprime la connexion au dépôt d'un seul projet Jamdesk.
Effets :
- Les déploiements automatiques s'arrêtent pour ce projet
- La GitHub App reste installée sur GitHub
- Les autres projets Jamdesk ne sont pas affectés
- La liaison de votre compte personnel n'est pas affectée
Quand l'utiliser : Vous voulez connecter un dépôt différent, ou arrêter temporairement les déploiements.
Comment se reconnecter : Accédez à Paramètres du projet → Dépôt Git et sélectionnez un dépôt.
Délier GitHub (Paramètres utilisateur)
Ce que ça fait : Supprime votre identité GitHub de votre profil Jamdesk.
Effets :
- Votre nom d'utilisateur GitHub n'apparaît plus dans votre profil
- L'attribution des builds se rabat sur la correspondance par e-mail
- Toutes les connexions aux dépôts restent intactes
- La GitHub App reste installée
Quand l'utiliser : Vous voulez lier un compte GitHub différent, ou supprimer la connexion.
Comment relier : Accédez à Paramètres utilisateur → Compte GitHub → Lier le compte GitHub.
Désinstaller la GitHub App (sur GitHub)
Ce que ça fait : Supprime complètement l'accès de Jamdesk à votre compte GitHub.
Effets :
- Tous les projets Jamdesk utilisant cette installation perdent l'accès
- Les déploiements automatiques s'arrêtent pour tous les projets concernés
- Les webhooks sont supprimés
- Les liaisons de compte personnel ne sont pas affectées
Désinstallez la GitHub App uniquement si vous souhaitez supprimer l'accès de Jamdesk à TOUS vos dépôts. Cela affecte chaque projet Jamdesk connecté à votre compte GitHub.
Comment désinstaller :
- Accédez à Paramètres GitHub → Applications → Installed GitHub Apps
- Trouvez « Jamdesk » et cliquez sur Configure
- Faites défiler vers le bas et cliquez sur Uninstall
Référence rapide
| Action | Emplacement | Portée | Réversible ? |
|---|---|---|---|
| Déconnecter GitHub | Paramètres du projet → Dépôt Git | Un seul projet | Oui - reconnexion possible à tout moment |
| Délier GitHub | Paramètres utilisateur → Compte GitHub | Votre compte | Oui - relier possible à tout moment |
| Désinstaller la GitHub App | Paramètres GitHub | Tous les projets | Oui - réinstallation possible |
Dépannage
« Vous avez déjà installé Jamdesk ? »
Si vous avez déjà installé la GitHub App Jamdesk, cliquer sur « Install GitHub App » vous mène vers la page des paramètres GitHub au lieu de la page d'installation. C'est normal ! Voici comment terminer la configuration :
Faites défiler jusqu'à la section Repository access sur la page des paramètres GitHub.
Si le bouton Save est désactivé (grisé), basculez de « All repositories » vers « Only select repositories », puis revenez en arrière.
Cliquez sur le bouton vert Save. Jamdesk détecte le changement et poursuit la configuration.
Pop-up bloquée
Si la pop-up GitHub ne s'ouvre pas, votre navigateur l'a peut-être bloquée. Recherchez une icône de blocage de pop-up dans votre barre d'adresse, autorisez les pop-ups depuis Jamdesk, puis cliquez sur Try Again.
« Mes builds affichent 'Unknown user' »
Votre compte GitHub personnel n'est pas lié. Accédez à Paramètres utilisateur → Lier le compte GitHub.
« Le dépôt n'apparaît pas »
La GitHub App n'a pas accès à ce dépôt. Accédez à Paramètres GitHub, trouvez Jamdesk, et ajoutez le dépôt.
« Les builds ne se déclenchent pas »
- Vérifiez que le dépôt est connecté dans Paramètres du projet → Dépôt Git
- Vérifiez que vous poussez vers la branche configurée
- Vérifiez la livraison des webhooks dans les paramètres du dépôt GitHub
« Je ne peux pas accéder aux dépôts de l'organisation »
Un administrateur de l'organisation doit approuver l'installation de la GitHub App. Demandez à votre administrateur d'installer ou d'approuver Jamdesk dans les paramètres de l'organisation.