Search Composal documentation

Search public documentation, commands, and release notes.

Composal Preview

Have Composal build and deploy the pull request before testing it.

Contents

Choose this when your app is hosted on Composal and you want Verify to build and deploy the PR for you.

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. Host the app on Composal and create its preview profile: follow Set up PR previews for Verify. The app must be linked to this repository, and the profile must supply every variable and credential the app needs, because no one approves sharing for these previews.
  2. In Who Builds Your PR Previews?, choose Composal. It uses the repository's preview profile and shows which profile it builds and which service it opens.
  3. To use another profile or service, choose Change, then pick the Preview Profile and Open This Service: usually the public web service that opens your app, rather than a background worker.
  4. Continue to Turn On PR Testing.

What happens next

Verify builds the PR's current commit, deploys the preview, and waits for the service and its HTTPS link to be ready. The profile's resource-sharing and expiry settings apply.

New setups keep the default preview access, organization members only, so the browser needs credentials that can pass Composal's preview protection. Preview access is not a choice on this page. Use dedicated test accounts for your app.

If the preview is not found

Check that the build has finished, the selected web service is healthy, and its HTTPS URL is ready. Confirm that the test account can pass preview protection. To see a deploy error directly, create a manual preview from the same profile and PR branch, as in step 6 of the hosting setup.

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.