PullPreview

A GitHub Action for running live preview environments for pull requests in your own cloud account. Add a label to a PR, let PullPreview provision or restore an instance, deploy your app with your existing setup, and report the preview URL back into GitHub.

Preview flow

Step 1 - Add the pullpreview label

Adding the label triggers the deployment. A PR comment appears immediately with the status set to pending.

Step 2 - Instance is provisioned

PullPreview creates a preview instance and waits for SSH access.

Step 3 - Preview environment is live

The PR comment is updated with a live preview URL.

Step 4 - Remove the label to destroy the preview

When the label is removed, the preview environment is automatically destroyed.

High-level features

• Fits existing deployment setups: Deploy with Docker Compose or Helm instead of adapting your app to a proprietary preview platform.
• Runs in your own cloud account: PullPreview supports Lightsail and Hetzner while keeping your code and infrastructure under your control.
• Reviewer-friendly lifecycle: Preview creation, redeploys, status comments, and cleanup all stay tied to the pull request workflow in GitHub.
• Practical to operate: HTTPS, SSH access, persistent state across redeploys, and troubleshooting workflows are built into the deployment model.

How to get started

1. Follow the Getting Started guide.
2. Choose between Deployment Targets for compose and helm.
3. Pick a provider in Providers.
4. Start from one of the Workflow Examples.

Documentation

Full documentation lives in the wiki.

Getting started

• Getting Started
• Migrating from v5 to v6
• Workflow Examples

Choose and configure

• Deployment Targets
• Providers
• Inputs
• Outputs
• SSL HTTPS Configuration
• Using a custom domain

Operate and debug

• Lifecycle
• PR Comments and Job Summary
• CLI
• Troubleshooting
• FAQ

PullPreview is open source. For licensing details for commercial repositories, see pullpreview.com and the FAQ.