Activation de la synchronisation GitHub

Configurer et autoriser l’intégration GitHub pour GitBook

Commencer

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

Options de configuration de la synchronisation GitHub.

S’authentifier avec GitHub

Si vous configurez la synchronisation GitHub 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 la synchronisation Git. Si vous avez déjà lié votre compte, il se peut que vous deviez tout de même vous authentifier via GitHub.

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

Pour vous aider à identifier les comptes 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à votre compte GitBook associé à GitHub, vous pouvez vous connecter à ce compte utilisateur et dissocier votre compte GitHub (dans les paramètres) avant de vous reconnecter et de lier votre compte actuel.

En savoir plus sur notre page de dépannage.

Installez l’application GitBook sur votre compte GitHub

Si ce n’est pas déjà fait, vous verrez une invite pour ajouter l’application GitBook à votre compte GitHub.

Suivez les instructions dans la fenêtre contextuelle GitHub et donnez à GitBook des autorisations spécifiques sur le dépôt, ou autorisez l’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 souhaitez 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 le bon périmètre (c’est-à-dire votre compte personnel ou l’organisation GitHub où se trouve le dépôt). Vous devez é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 bon dépôt, choisissez la branche sur 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 synchronisera 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 souhaitez rapidement y ajouter votre contenu GitBook.

2. GitHub -> GitBook synchronisera le contenu de votre espace depuis la branche sélectionnée. C’est idéal si vous avez déjà du contenu Markdown dans un dépôt et souhaitez l’importer dans GitBook.

Écrire et valider

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

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

Lorsque vous validez sur GitHub, chaque commit sera synchronisé dans votre espace GitBook comme un commit d’historique.

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