Activation de la synchronisation GitHub

Configurez et autorisez l’intégration GitHub pour GitBook

Pour 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, puis sélectionnez Configurer. Dans la liste des fournisseurs, sélectionnez Synchronisation GitHub.

Options de configuration de la synchronisation GitHub.

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 votre compte est déjà lié, vous devrez peut-être quand même 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 connecter 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 puis de lier votre compte actuel.

En savoir plus sur notre page de dépannage.

Installer 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 accordez à GitBook des autorisations spécifiques sur certains dépôts, ou autorisez l’accès à tous les dépôts, selon vos besoins.

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

Sélectionnez le compte et le dépôt que vous souhaitez synchroniser 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 GitHub GitBook 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 GitHub GitBook.

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

Effectuer une synchronisation initiale

Lors de la première synchronisation, vous aurez le choix entre deux directions de synchronisation :

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 importer rapidement 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

C’est bon, vous pouvez commencer. Vous remarquerez que si votre espace était en édition en direct mode, les modifications en direct sont désormais verrouillées. Cela nous permet de synchroniser de manière fiable le contenu vers votre dépôt lorsqu’une personne de votre équipe fusionne une demande de modification dans GitBook.

Lorsque vous effectuez des modifications dans GitBook, chaque fusion de demande de modification entraînera un commit sur votre branche GitHub sélectionnée.

Lorsque vous effectuez un commit sur GitHub, chaque commit sera synchronisé avec votre espace GitBook sous forme de commit d’historique.

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