Jamdesk Documentation logo

Problèmes GitHub

Corrigez les boucles d'installation GitHub sur comptes d'entreprise, organisations et dépôts manquants, webhooks en échec, permissions et branches.

La plupart des problèmes d'intégration GitHub proviennent de problèmes de permissions, d'échecs de webhook ou d'incohérences de branche.

L'organisation n'apparaît pas lors de la configuration

Pendant le flux de configuration initial, Jamdesk affiche vos organisations GitHub pour que vous puissiez choisir où créer le dépôt. Cette liste provient de l'API OAuth de GitHub, et GitHub masque certaines organisations dans deux cas :

  • Restrictions des applications OAuth : votre organisation restreint l'accès aux applications tierces (paramètre par défaut de GitHub pour les nouvelles organisations) et n'a pas encore approuvé Jamdesk.
  • SSO SAML : votre organisation exige une authentification SAML avant que l'API ne la renvoie.

Si vous êtes propriétaire de l'organisation, vous pouvez approuver Jamdesk immédiatement :

  1. Cliquez sur grant Jamdesk access on GitHub sous le sélecteur d'organisation (ou allez dans GitHub → Settings → Applications → Authorized OAuth Apps → Jamdesk)
  2. Sous Organization access, cliquez sur Grant à côté de votre organisation
  3. De retour dans le flux de configuration de Jamdesk, cliquez sur refresh the list. Votre organisation apparaît immédiatement

Si vous êtes membre (et non propriétaire), vous verrez plutôt un bouton Request ; cliquer dessus envoie une demande d'approbation à vos administrateurs d'organisation.

Si vous êtes membre sans droits de propriétaire, envoyez d'abord une demande d'approbation à vos administrateurs :

  1. Allez dans GitHub → Settings → Applications → Authorized OAuth Apps → Jamdesk
  2. Sous Organization access, cliquez sur Request à côté de votre organisation. Cela notifie vos administrateurs d'organisation
  3. Un administrateur l'approuve dans Settings → Third-party access → OAuth application policy de l'organisation (les demandes en attente affichent un bouton Approve)
  4. Retournez au flux de configuration de Jamdesk et cliquez sur refresh the list ; votre organisation devrait maintenant apparaître

Consultez le guide de GitHub sur l'approbation des applications OAuth pour votre organisation pour connaître les étapes détaillées.

Vous ne voulez pas attendre l'approbation d'un administrateur ? Choisissez votre compte personnel lors de la configuration, puis transférez le dépôt vers votre organisation par la suite :

  1. Terminez la configuration de Jamdesk avec votre compte personnel
  2. Accédez au dépôt créé sur GitHub
  3. Accédez à Settings → General → Danger Zone
  4. Cliquez sur Transfer et sélectionnez votre organisation comme destination
  5. Dans Jamdesk, déconnectez puis reconnectez le dépôt depuis la page Settings de votre projet

Déconnecter puis reconnecter génère une nouvelle URL de documentation (par exemple, your-project.jamdesk.app peut changer). Si vous avez déjà partagé votre URL ou configuré un domaine personnalisé, contactez le support avant de vous déconnecter afin que nous puissions préserver votre configuration.

Cela ne fonctionne pas si votre entreprise gère votre compte GitHub. Consultez plutôt comptes GitHub gérés par l'entreprise.

Comptes GitHub gérés par l'entreprise

Si votre entreprise gère votre compte GitHub (GitHub appelle cela un Enterprise Managed User, ou EMU), GitHub ne vous permet pas d'installer des applications sur votre propre compte, uniquement sur une organisation. S'il n'existe aucune organisation à utiliser, cliquer sur Install sur GitHub vous renvoie simplement à la page de l'application Jamdesk. Lors de l'inscription, Jamdesk affiche « Your organization manages this GitHub account ».

Les noms d'utilisateur gérés se terminent par un underscore et un code d'entreprise, comme jsmith_acme. GitHub explique ces limites sur sa page consacrée aux comptes utilisateur gérés.

Vous pouvez résoudre cela de deux manières.

  1. Demandez à un propriétaire d'entreprise de créer une organisation depuis l'onglet Organizations de votre entreprise. Demandez-lui de vous autoriser à y créer des dépôts.
  2. Transférez votre dépôt de documentation dedans. Dans le dépôt, allez dans Settings, cliquez sur Transfer en bas de page, puis choisissez la nouvelle organisation.
  3. Dans Jamdesk, cliquez sur Connect an existing repository (ou Install GitHub App dans les paramètres du projet). Sur GitHub, choisissez l'organisation, sélectionnez Only select repositories, choisissez votre dépôt, puis installez.

Si GitHub affiche Request au lieu de Install, un propriétaire de l'organisation reçoit un e-mail pour l'approuver. Cliquez à nouveau sur le bouton Jamdesk une fois que c'est fait.

Utilisez cette méthode si votre entreprise ne peut pas ajouter d'organisation. Vérifiez d'abord avec votre administrateur GitHub, car la documentation résidera en dehors du GitHub de votre entreprise.

  1. Dans une fenêtre de navigation privée, connectez-vous à GitHub avec un compte personnel (ou créez-en un).
  2. Créez un dépôt privé vide sur ce compte.
  3. Poussez-y une copie de votre documentation. GitHub ne peut pas transférer de dépôts hors d'une entreprise gérée, une copie est donc nécessaire.
git remote set-url origin https://jsmith@github.com/jsmith/product-docs.git
git push -u origin main

Conservez jsmith@ dans l'URL pour que Git vous demande les identifiants de votre compte personnel.

  1. Dans Jamdesk, cliquez sur Connect an existing repository (ou Install GitHub App dans les paramètres du projet), installez Jamdesk sur votre compte personnel, puis choisissez le dépôt.

Les comptes gérés ne peuvent pas pousser vers des dépôts en dehors de votre entreprise ; toute personne qui modifie la documentation a donc besoin d'un compte GitHub personnel. Ajoutez-les au dépôt en tant que collaborateurs.

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

Si votre dépôt n'apparaît pas dans la liste :

  1. Allez dans GitHub → Settings → Applications → Jamdesk
  2. Vérifiez que l'accès au dépôt a bien été accordé
  3. Cliquez sur Configure pour ajouter d'autres dépôts

Pour les dépôts d'organisation :

  1. Un administrateur de l'organisation doit approuver Jamdesk
  2. Allez dans les paramètres de l'organisation → Third-party access
  3. Approuvez la demande d'accès de Jamdesk

Les dépôts privés nécessitent une autorisation GitHub. Réautorisez Jamdesk si nécessaire.

Les builds ne se déclenchent pas

Si les push ne déclenchent pas de builds :

1
Vérifiez le webhook
  1. Accédez à votre dépôt sur GitHub
  2. Accédez à Settings → Webhooks
  3. Repérez le webhook Jamdesk
  4. Vérifiez « Recent Deliveries » pour détecter des erreurs
2
Vérifiez la branche

Les builds ne se déclenchent que sur la branche configurée. Vérifiez Settings dans Jamdesk.

3
Vérifiez qui a poussé

Si le build apparaît comme échoué avec un message indiquant que la personne qui a poussé n'est pas membre, invitez-la dans Project Settings → Members ou demandez-lui de lier son compte GitHub. Voir GitHub.

4
Resynchronisez la connexion
  1. Accédez à Settings du projet dans Jamdesk
  2. Cliquez sur Re-sync GitHub

Erreurs de Webhook

404 Non trouvé

L'endpoint du webhook était injoignable.

Solution : Resynchronisez la connexion GitHub dans les paramètres du projet.

401 Non autorisé

L'authentification a échoué.

Solution :

  1. Accédez aux paramètres de votre compte GitHub
  2. Accédez à Applications → Authorized OAuth Apps
  3. Révoquez Jamdesk
  4. Réautorisez-le dans les paramètres de Jamdesk

500 Erreur serveur

Problème temporaire de Jamdesk.

Solution : Attendez quelques minutes puis effectuez un nouveau push, ou déclenchez un rebuild manuel.

Erreurs de permission

« Repository not found » pendant le build :

  • Le dépôt a peut-être été supprimé ou renommé
  • Jamdesk a peut-être perdu l'accès
  • Réautorisez votre connexion GitHub

Problèmes de branche

La mauvaise branche est buildée

Vérifiez la branche configurée dans Settings → Repository.

Branche renommée ou supprimée

Mettez à jour le paramètre de branche pour qu'il corresponde au nouveau nom de branche.

Toujours des problèmes ?

Contacter le support

Indiquez l'URL de votre dépôt et les messages d'erreur

Articles connexes

Référence des erreurs

Liste complète des codes d'erreur

Contacter le support

Faites remonter les problèmes non résolus