Activation de la synchronisation GitLab

Configurez et autorisez l'intégration GitLab pour GitBook

Prise en main

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 Synchronisation GitLab, puis cliquez sur Configurer.

Options de configuration de la synchronisation GitLab.

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 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 de votre utilisateur 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 attaché, assurez-vous aussi qu’il dispose d’un Mainteneur ou Admin rôle.

Vous pouvez ensuite coller le jeton dans le champ 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 le contenu de votre GitBook.

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

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

Pour de nombreux dépôts GitLab, la branche main peut être automatiquement définie comme protégée. Si tel est le cas, nous recommandons d’ajouter une branche spécifique pour synchroniser votre contenu entre les deux. Vous pouvez ensuite la fusionner dans main et maintenir 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 importer rapidement 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 du contenu Markdown existant 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 édition en direct les éditions en direct sont maintenant verrouillées. Cela permet à GitBook 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 sur GitBook, chaque fusion de demande de modification entraînera un commit sur la branche GitLab sélectionnée.

Lorsque vous effectuez un commit sur GitLab, chaque commit sera synchronisé avec votre espace GitBook en tant que commit historique.