Add preview links to your GitHub Pull Requests
Doctave can automatically add preview links to your GitHub Pull Requests. This way you can quickly preview the changes made in a pull request.
When enabled, Doctave will add a preview link to the pull request's timeline.
Enabling the GitHub preview link integration
1. Set up a GitHub action for deploying your site
In order for build previews to work, you will first have to set up a GitHub action that deploys your site to Doctave. See Publishing from CI/CD for more information.
2. Enable GitHub preview links
Once you have successfully set up publishing from CI/CD, you can enable GitHub preview links on the Integrations page. You will be redirected to install the Doctave GitHub app on your GitHub organization.
FAQ
Does the Doctave GitHub app deploy my site?
No, the Doctave GitHub app doesn't deploy your site. It only adds a preview link to your pull requests. To set up deployment, see Publishing from CI/CD.
What permissions does the Doctave GitHub app require?
The Doctave GitHub app requires the following permissions:
| Permission | Scope | Description |
|---|---|---|
| Metadata | Read | Mandatory for all GitHub apps. |
| Deployments | Read, Write | Required to add the preview link to the pull request timeline. |
| Pull Requests | Read | Required to know when a pull request is opened or closed. |
Does the Doctave GitHub app have access to my code?
No, the Doctave GitHub app doesn't have access to your repository's code.