Aperçu de pull request GitHub

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

Lorsque vous soumettez une pull request (PR) vers une branche GitHub qui a été 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 effectuer une dernière série de vérifications avant de fusionner une PR, ce qui vous permet de voir vos modifications dans un environnement non production avant de les fusionner dans votre branche synchronisée.

Comment accéder aux liens de prévisualisation

Ce comportement fonctionne immédiatement, à condition que vous ayez accordé au GitBook GitHub app les autorisations en lecture 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. Cliquer sur le Details lien sur le statut vous mènera à 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 depuis des forks de votre référentiel. 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 référentiel public et le faire servir sous votre nom.

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

FAQ

Pourquoi ne puis-je pas voir une prévisualisation de ma documentation GitBook dans ma pull request ?

Causes courantes :

• Votre site n'est pas publié. Les URL de prévisualisation des PR sont servies depuis votre site de documentation publié (sur .gitbook.io ou votre domaine personnalisé).

• Votre site est protégé par un accès authentifié. Les prévisualisations PR de Git Sync ne sont pas disponibles pour les sites publiés derrière un accès authentifié.