Aperçu des pull requests GitHub

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

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

Vous pouvez utiliser cette fonctionnalité pour disposer d’une dernière couche de vérifications avant de fusionner une PR, ce qui vous permet de voir vos modifications dans un environnement hors production 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é le application GitBook GitHub les autorisations de lecture seule nécessaires aux 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 d’aperçu unique. Cliquer sur le Détails lien du statut vous mènera à l’URL d’aperçu de votre contenu. Vous pourrez alors vous assurer que le contenu est conforme aux 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 d’aperçus pour les PR ouvertes depuis des forks de votre dépôt. Comme le contenu de l’aperçu 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 diffuser sous votre nom.

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

FAQ

Pourquoi ne puis-je pas voir un aperçu de ma documentation GitBook dans ma pull request ?

Causes fréquentes :

• Votre site n’est pas publié. Les URL d’aperçu des PR sont servies depuis votre site de documentation publié (sur .gitbook.io ou votre domaine personnalisé).

• Votre site est derrière un accès authentifié. Les aperçus des PR Git Sync ne sont pas disponibles pour les sites publiés derrière un accès authentifié.