GitHub Deployment

Choose this when your deployment provider publishes deployments to GitHub. Verify reads the ready deployment link from GitHub; it does not build your app in this mode.

Start on Verify → your project → PR Testing. You need administrator access and a connected GitHub repository. If you have not configured testing yet, follow PR configuration first. The screenshot shows a local example project.

Set it up

1. In Who Builds Your PR Previews?, choose A Hosting Service.
2. Composal looks at recent open and closed PRs for a successful, non-production GitHub deployment. If it finds one, it shows something like Found Vercel previews on #142, with the deployment name and an example URL. Choose Use Vercel Previews to accept it.
3. Otherwise choose Choose Another Service. Vercel and Render fill in a GitHub deployment named Preview. For another host, choose Other Service, then Reports a Deployment, and enter the Deployment Name your provider reports to GitHub, usually Preview.
4. Continue to Turn On PR Testing.

If Composal cannot read GitHub, choose Look Again to retry.

The same answer from the CLI is com verify pr-testing setup --previews hosting --deployment Preview.

What happens next

Your provider deploys the PR. Verify waits for GitHub to report a successful, non-production deployment of the current PR commit, with a link to the app.

The GitHub App needs permission to read deployments. If the provider only puts the link in a comment, use PR Comments. If the link only exists as a workflow output, use Your CI.

If the preview is not found

Check that GitHub shows a successful preview deployment for the current commit, the environment name matches exactly, and the deployment has an app URL. Confirm that the GitHub App can read deployments.

If no matching preview arrives within one hour, the run is blocked. Fix the setup, then request a new run.

Return to PR configuration to turn on testing, try a PR, and configure merge checks.