PreviewHQ
  • Introduction
  • Basics
    • What is Continuous Product Review?
    • What is a Preview Environment?
    • Use Cases
      • Product and Stakeholder Review
      • QA Environments
      • Automated End-to-End Testing
      • Sales Demo Environments
      • Support Training
  • Getting Started
    • Installation
    • Add Configuration
    • Add a Cluster
    • Create a Deployment
      • with a Pull Request
      • with the Dashboard
      • with the CLI
      • with the API
  • Technical Stuff
    • Defining Deployments
      • Helm Charts
      • Kubernetes Manifests
      • [UNRELEASED] Terraform
    • Configuration File
      • Branches
      • Services
      • Chart Repositories
      • Chart Values
      • Docker Registries
      • Images
      • Webhooks
    • Template Strings
    • Using Seed Data
      • Using Shared Data Sources
    • Access Control
      • Preview Application Access
      • Preview Environment Access
    • Using Third-Party Integrations
    • Debugging
    • Current Limitations
  • Sample Applications
    • Emojivoto
    • Guestbook - Helm
    • Guestbook - Manifests
  • misc
    • FAQ
    • Changelog
    • Telemetry Data
    • Links
      • Homepace
      • Dashboard
Powered by GitBook
On this page

Was this helpful?

  1. Getting Started
  2. Create a Deployment

with a Pull Request

The main workflow for Preview is the automated deployment of Preview environments for Pull Requests. By default, Preview will deploy a Preview environment for each Pull Request created against private repositories in your organization.

If you would like to modify this behaviour, automatic Preview deployments for Pull Requests can be disabled. If you chose to go this route, deployments can still be created on demand via Pull Request Commands.

Commands

Preview accepts commands in the form of Pull Request comments. These commands will always be scoped to the current Pull Request.

/preview deploy|start

Deploy the environment for the PR. This will either create, or rebuild, the environment. If rebuilding, stateful services will not be reset.

/preview shutdown|stop

Destroy the environment for the PR. The environment, including any stateful data, will be removed. This is the same behaviour which occurs automatically when a PR is merged or closed.

[Coming soon] - /preview reset

Destroy and recreate the environment for the PR. The environment, including any stateful data, will be destroyed, and recreated as a fresh environment. Any stateful data will be lost.

PreviousCreate a DeploymentNextwith the Dashboard

Last updated 4 years ago

Was this helpful?