Activation de la synchronisation GitHub

Configurez et autorisez l'intégration GitHub pour GitBook

Commencer

Dans l’espace que vous voulez synchroniser avec votre dépôt GitHub, allez dans le en-tête de l’espace en haut à droite, et sélectionnez Configurer. Dans la liste des fournisseurs, sélectionnez GitHub Sync.

Options de configuration de GitHub Sync.

S’authentifier avec GitHub

Si vous configurez GitHub Sync pour la première fois et que vous n’avez pas encore lié de compte GitHub, il vous sera demandé de le faire lorsque vous commencerez à configurer Git Sync. Si vous avez déjà lié votre compte, il se peut que vous deviez toujours vous authentifier via GitHub.

Si vous voyez un 'Comptes potentiellement dupliqués' message d’erreur à cette étape, cela signifie que votre compte GitHub est déjà lié à un autre compte utilisateur GitBook.

Pour vous aider à identifier quels comptes sont liés, vous devrez vous déconnecter de cette session et vous reconnecter en utilisant la méthode de connexion avec GitHub.

Si vous connaissez déjà le compte GitBook associé à GitHub, vous pouvez vous connecter à ce compte utilisateur et dissocier votre compte GitHub (fait dans les paramètres) avant de vous reconnecter et de lier votre compte actuel.

En savoir plus sur notre page de dépannage.

Installer l’application GitBook sur votre compte GitHub

Si vous ne l’avez pas encore fait, vous verrez une invite pour ajouter l’ application GitBook à votre compte GitHub.

Suivez les instructions dans la fenêtre contextuelle GitHub et accordez soit à GitBook des autorisations spécifiques sur des dépôts, soit un accès à tous les dépôts, selon vos besoins.

Sélectionnez un dépôt et une branche

Sélectionnez le compte et le dépôt que vous voulez garder synchronisés avec votre contenu GitBook.

Vous ne voyez pas votre dépôt ? Si vous ne trouvez pas votre dépôt dans la liste, assurez-vous d’avoir installé l’ application GitBook GitHub dans la bonne portée (c’est‑à‑dire votre compte personnel ou l’organisation GitHub où se trouve le dépôt). Vous devriez également vérifier que vous avez configuré le bon accès au dépôt dans l’application GitBook GitHub.

Une fois que vous avez sélectionné le dépôt correct, choisissez la branche vers laquelle vous souhaitez que les commits soient poussés et synchronisés.

Effectuer une synchronisation initiale

Lors de la première synchronisation, vous aurez la possibilité de synchroniser dans l’une des deux directions :

1. GitBook -> GitHub va synchroniser le contenu de votre espace vers la branche sélectionnée. C’est idéal si vous partez d’un dépôt vide et que vous souhaitez importer rapidement votre contenu GitBook.

2. GitHub -> GitBook va synchroniser le contenu de votre espace depuis la branche sélectionnée. C’est idéal si vous avez du contenu Markdown existant dans un dépôt et que vous souhaitez l’intégrer dans GitBook.

Écrire et valider

Vous êtes prêt. Vous remarquerez que si votre espace était en édition en direct le mode d’édition en direct est maintenant verrouillé. Cela nous permet de synchroniser de manière fiable le contenu vers votre dépôt lorsqu’un membre de votre équipe fusionne une demande de modification dans GitBook.

Lorsque vous modifiez dans GitBook, chaque fusion de demande de modification entraînera un commit sur la branche GitHub que vous avez sélectionnée.

Lorsque vous validez sur GitHub, chaque commit sera synchronisé vers votre espace GitBook en tant que commit d’historique.

L’application GitHub qui alimente notre intégration GitHub n’est actuellement pas disponible pour les clients disposant d’instances GitHub Enterprise Server.