Activation de la synchronisation GitLab

Configurez et autorisez l’intégration GitLab pour GitBook

Pour commencer

Dans l’espace que vous souhaitez synchroniser avec votre dépôt GitLab, ouvrez le menu de l’espace en haut à droite, puis sélectionnez Synchroniser avec Git. Dans la liste des fournisseurs, sélectionnez GitLab Sync , 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 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 associé, assurez-vous aussi qu’ils disposent 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électionner 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 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.

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 recommandons d’ajouter une branche spécifique entre laquelle 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 le choix entre deux directions de synchronisation :

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 que vous 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 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 dans GitBook, chaque fusion de demande de modification entraînera un commit sur votre branche GitLab sélectionnée.

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