Home

Branching

Use Supabase Branches to test and preview changes

Use branching to safely experiment with changes to your Supabase project.

Supabase branches create separate environments that spin off from your main project. You can use these branching environments to create and test changes like new configurations, database schemas, or features without affecting your production setup. When you're ready to ship your changes, merge your branch to update your production instance with the new changes.

How branching works

  • Separate Environments: Each branch is a separate environment with its own Supabase instance and API credentials.
  • Preview Branches: You can create multiple Preview Branches for testing.
  • Persistent Branches: Persistent branches are long-lived branches. They aren't automatically paused or deleted due to non-inactivity or merging.
  • Managing Branches: You can create, review, and merge branches either automatically via our GitHub integration or directly through the dashboard (currently in beta). All branches show up in the branches page in the dashboard, regardless of how they were created.
  • Data-less: New branches do not start with any data from your main project. This is meant to better protect your sensitive production data. To start your branches with data, you can use a seed file if using the GitHub integration.

Deploying to production

When you merge any branch into your main project, Supabase automatically runs a deployment workflow to deploy your changes to production. The deployment workflow is expressed as a Directed Acyclic Graph where each node represents one of the following deployment steps.

  1. Clone - Checks out your repository at the specified git branch (optional for Branching via Dashboard)
  2. Pull - Retrieves database migrations from your main project (also initialises the migration history table when Branching via Dashboard)
  3. Health - Waits up to 2 minutes for all Supabase services on your branch to be running and healthy, including Auth, API, Database, Storage, and Realtime
  4. Configure - Updates service configurations based on your config.toml file (only available for Branching via GitHub)
  5. Migrate - Applies pending database migrations and vault secrets to your branch
  6. Seed - Runs seed files to populate your branch with initial data (must be enabled in config.toml for persistent branches)
  7. Deploy - Deploys any changed Edge Functions and updates function secrets

If a parent deployment step fails, all dependent children steps will be skipped. For e.g., if your database migrations failed at step 5, our runner will not seed your branch because step 6 is skipped. If you are using GitHub integration, the same deployment workflow will be run on every commit pushed to your git branch.