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.

Composal Preview selected, with fields for the preview profile, browser entry service, preview access, and Verify environment template.
The profile controls the deployment. The entry service tells the browser which part of the app to open.

Set it up

  1. Create a preview profile for the hosted app connected to this repository.
  2. Select Composal Preview and choose that Composal Preview Profile.
  3. Choose the Browser Entry Service: usually the public web service that opens your app, rather than a background worker.
  4. Choose Preview Access and a Verify Environment Template.
  5. Choose Save Settings.

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.

With Organization Members access, the browser needs credentials that can pass Composal's preview protection. Public Preview URL makes the preview link publicly reachable; your app's own sign-in still applies. 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.

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 save your settings, try a PR, and configure merge checks.