Activer la synchronisation GitHub

Synchronisez votre dépôt GitHub avec GitBook

Ce guide vous expliquera comment configurer votre site GitBook avec un dépôt sur GitHub.

Options de configuration de GitHub Sync.

1

Ouvrez Git Sync pour votre site

Depuis votre site, ouvrez Git Sync dans la barre latérale.

2

Connecter GitHub

Connectez le compte GitHub qui a accès au dépôt que vous souhaitez synchroniser.

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 et de lier votre compte actuel.

En savoir plus sur notre page de dépannage.

3

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

Sous Dépôt source, sélectionnez le dépôt qui contient votre documentation. Sélectionnez la branche avec laquelle GitBook se synchronise. Si la branche n’existe pas, GitBook la crée lors de la synchronisation initiale.

Vous ne trouvez 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.

4

Choisissez une direction de synchronisation initiale

Choisissez la source de vérité pour la synchronisation initiale. Sélectionnez Inverser la direction si le contenu du dépôt doit remplacer le contenu GitBook.

GitHub → GitBook peut remplacer le contenu de votre section. Si vous sélectionnez un dépôt vide, GitBook peut remplacer votre section par le contenu vide du dépôt.

Avant de lancer la synchronisation initiale, confirmez le dépôt, la branche et la direction. Assurez-vous que le contenu de destination peut être remplacé sans risque.

5

Définissez le répertoire du projet

Si votre documentation se trouve dans un sous-répertoire, indiquez-le sous Répertoire du projet. GitBook stocke le fichier docs.yaml de votre site dans ce répertoire. Utilisez cette configuration si votre documentation se trouve dans un monorepo.

6

Associez vos espaces

Sous Mappage du contenu, attribuez à chaque espace un répertoire dans le dépôt. Utilisez ./ pour les chemins relatifs au répertoire du projet. Utilisez / pour les chemins depuis la racine du dépôt. Les espaces nouvellement liés se synchronisent automatiquement.

7

Vérifiez les options avancées

Si nécessaire, configurez les fichiers d’instructions d’agent, un modèle de message de commit ou les aperçus de forks.

8

Synchronisez votre site

Cliquez sur Synchroniser pour lancer la synchronisation initiale.

9

Écrire et valider

Fusionnez une demande de modification dans GitBook pour valider ses changements vers GitHub. Les commits vers GitHub se synchronisent ensuite avec GitBook.

Exclure un espace de la synchronisation Git à l’échelle du site

Dans le mappage du contenu Git Sync du site, cliquez sur l’icône de suppression à côté de l’espace que vous souhaitez exclure. Vous pouvez ensuite configurer Git Sync depuis cet espace.

Si le site utilise déjà Git Sync, GitBook vous demande de choisir un périmètre :

• Sélectionnez le dépôt et la branche du site pour ajouter l’espace à la synchronisation Git à l’échelle du site.
• Sélectionnez un dépôt et une branche indépendants pour configurer Git Sync de l’espace.

Si le site n’utilise pas Git Sync, GitBook configure Git Sync indépendamment pour l’espace.

Pour configurer Git Sync pour un seul espace, dans l’espace que vous souhaitez synchroniser, cliquez sur Configurer à côté de Git Sync dans le l’en-tête de l’espace. Dans la liste des fournisseurs, cliquez sur GitHub Sync.

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