Activer 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, accédez au menu de l’espace en haut à droite, puis 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 utilisateur de GitLab.

Assurez-vous d’activer l’accès suivant pour votre jeton :

• api

• read_repository

• write_repository

Si les jetons que vous créez sont également associés à un rôle spécifique, assurez-vous aussi qu’il dispose du rôle Mainteneur ou Administrateur .

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 autorisations correctes lors de la création de votre jeton API.

Une fois le dépôt correct sélectionné, choisissez la branche vers laquelle vous souhaitez envoyer les commits et depuis laquelle vous souhaitez synchroniser.

Pour de nombreux dépôts GitLab, la main branche peut être automatiquement définie comme protégée. Si c’est le cas, nous vous recommandons d’ajouter une branche spécifique entre lesquelles synchroniser votre contenu. Vous pourrez ensuite la fusionner 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 suivantes :

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 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 édition en direct , les modifications en direct sont désormais verrouillées. Cela permet à GitBook de synchroniser de manière fiable le contenu vers votre dépôt lorsqu’une personne de votre équipe fusionne une demande de changement dans GitBook.

Lorsque vous modifiez dans GitBook, chaque fusion de demande de changement donnera lieu à un commit sur la branche GitLab sélectionnée.

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