Aperçu des pull requests GitHub

Voir un aperçu de votre contenu lors de la création d’une pull request sur GitHub

Lorsque vous soumettez une pull request (PR) à une branche GitHub qui a été synchronisée avec un espace GitBook, vous pouvez prévisualiser le contenu avant de fusionner. Cela vous permet de vérifier l'impact des modifications avant de les fusionner.

Vous pouvez utiliser cette fonctionnalité pour effectuer une dernière vérification avant de fusionner une PR, ce qui vous permet de voir vos modifications dans un environnement non productif avant de les fusionner dans votre branche synchronisée.

Comment accéder aux liens de prévisualisation

Ce comportement fonctionne immédiatement, à condition d'avoir accordé à l'application GitBook GitHub les autorisations en lecture seule nécessaires pour les PR.

Pour chaque PR créée en utilisant une branche cible synchronisée avec un espace GitBook, vous verrez un statut ajouté à la PR avec une URL de prévisualisation unique. En cliquant sur le lien Détails du statut, vous accéderez à l'URL de prévisualisation de votre contenu. Vous pouvez alors vous assurer que le contenu est conforme à vos attentes avant de fusionner la PR.

Les liens de prévisualisation ne sont accessibles qu'aux utilisateurs disposant d'un compte GitBook.

Considérations de sécurité

Pour des raisons de sécurité, par défaut, GitBook ne génère actuellement pas de prévisualisations pour les PR ouvertes à partir de forks de votre dépôt. Comme le contenu de la prévisualisation de la PR est accessible sous votre propre domaine, que ce soit sur .gitbook.io ou votre domaine personnalisé, un utilisateur pourrait générer du contenu malveillant dans un fork de votre dépôt public et le faire servir sous votre nom.

Nous permettons aux utilisateurs de configurer explicitement cela via une option dans les paramètres de synchronisation Git.