Activation de la synchronisation GitLab

Configurer et autoriser l’intégration GitLab pour GitBook

Commencer

Dans l’espace que vous souhaitez synchroniser avec votre dépôt GitLab, rendez-vous dans le menu de l’espace en haut à droite, et sélectionnez Synchroniser avec Git. Dans la liste des fournisseurs, sélectionnez GitLab Sync, puis cliquez sur Configurer.

Options de configuration de GitLab Sync.

Générez et saisissez votre jeton d’accès API

Vous pouvez générer un jeton d’accès API dans les paramètres utilisateur de votre compte GitLab.

Il existe deux types de jetons d’accès dans GitLab : Projet et Personnel. Notez que pour que l’intégration fonctionne, vous devrez utiliser un jeton Personnel, que vous pouvez générer depuis le menu des préférences utilisateur de GitLab.

Assurez-vous d’activer les accès suivants pour votre jeton :

• api

• read_repository

• write_repository

Si les jetons que vous créez ont également un rôle spécifique qui leur est attribué, assurez-vous aussi qu’il dispose d’un rôle Mainteneur ou Admin.

Vous pouvez ensuite coller le jeton dans le champ du jeton d’accès API lors de la configuration de votre intégration GitLab.

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

Sélectionnez le dépôt que vous souhaitez garder synchronisé avec votre contenu GitBook.

Vous ne voyez pas votre dépôt ? Assurez-vous d’avoir défini les bonnes autorisations lors de la création de votre jeton API.

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

Pour de nombreux dépôts GitLab, la branche main peut être automatiquement définie comme protégée. Si c’est le cas, nous vous recommandons d’ajouter une branche spécifique pour synchroniser votre contenu. Vous pourrez ensuite fusionner cette branche dans main et conserver la protection en place.

Effectuer une synchronisation initiale

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

1. GitBook -> GitLab 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. GitLab -> 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 permet à GitBook 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 GitLab sélectionnée.

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