GitHub Pull-Request Preview
When you submit a PR to a GitHub branch that has been synced to a GitBook space, you can preview the content before merging. This allows you to check the impact of changes before merging them.
You can use this feature to have a final layer of checks before merging a pull request (or PR), allowing you to see your changes in a non-production environment before merging it into your synced branch.
This behaviour works out-of-the-box, provided you have given the GitBook GitHub app the necessary read-only permissions to PRs.
In any PR where the target branch is synced with a GitBook space, a status will be added to the PR with a unique preview URL. Clicking the details link on the status will take you to the preview URL for your content. You can then make sure the content is as expected before merging the PR.
For security reasons, GitBook by default does not currently generate previews for PRs opened from forks of your repository: because the content of the PR preview is accessible under your own domain, whether on
.gitbook.ioor your custom domain, a user could generate malicious content in a fork of your public repository and have it served under your name.
We allow users to explicitly configure this through a new option in the Git Sync settings.