Preview Environments #

Preview Environments allow you to test changes in isolation before they are merged into the main branch. Each Pull Request can have its own dedicated environment that mirrors production.

What You’ll Learn #

• Overview - What are Preview Environments and why use them
• How to create and access Preview Environments
• Connecting to external integrations (Xero, QBO, etc.)
• Troubleshooting common issues

Quick Start #

1. Create a Pull Request against the main branch
2. Add the preview label to your PR
3. Wait ~40 minutes for the environment to be ready
4. Access your preview environment via the link in the PR comments

Key Features #

• Isolated Testing: Each PR gets its own complete environment
• Automatic Updates: Environment rebuilds when you push new commits
• Full Stack: Includes database, API, webapp, and all services
• External Access: Share URLs with stakeholders for testing
• Automatic Cleanup: Environments are deleted when PR is closed

For Different Roles #

Developers #

Use Preview Environments to test backend changes, API updates, and full-stack features before merging.

Product Managers #

Access Preview Environments to review new features and provide feedback early in the development process.

QA Engineers #

Test features in isolation with realistic data and external integrations before they reach production.