PullPreview is a GitHub Action for running live preview environments for pull requests in your own cloud account.

It supports two deployment targets:

• compose: deploy with Docker Compose on the preview instance
• helm: bootstrap k3s on the preview instance and deploy a Helm chart

Both targets work with the supported providers:

• lightsail (default)
• hetzner

Start here

• Getting Started
• Migrating from v5 to v6
• Deployment Targets
• Workflow Examples
• Inputs
• Outputs

Choose a deployment target

• Use Deployment Targets if you need help choosing between compose and helm.
• Use SSL HTTPS Configuration for proxy_tls, which is optional for compose and required for helm.
• Use CLI if you want to debug or run deployments outside GitHub Actions.

Configuration and operations

• Providers
• Environment variables
• Lifecycle
• PR Comments and Job Summary
• Using a custom domain
• Private docker registries
• Running a script before deployment
• Seed Data
• Deploying multiple preview environments per pull request
• Recommended AWS Configuration
• Troubleshooting
• FAQ

PullPreview is open source. A license is required for for-profit repositories; see pullpreview.com.

Next: Getting Started