mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Update branch framing (#37673)
* update branch framing * shorten preview name * Update apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> * Update apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> * Update apps/docs/content/guides/deployment/branching/branching-2.mdx Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> * Update apps/docs/content/guides/deployment/branching/branching-2.mdx Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> * Update apps/docs/content/guides/deployment/branching/branching-2.mdx Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> * Update apps/docs/content/guides/deployment/branching.mdx Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> * update name and add redirect --------- Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
This commit is contained in:
Saxon FletcherandChris Chinchilla authored and GitHub committed
1 parent
8ea9469e68
commit
d0972be7d5
6 files changed
+25
-21
No files matched your search
@@ -2477,11 +2477,12 @@ export const deployment: NavMenuConstant = {
|
||||
url: undefined,
|
||||
items: [
|
||||
{ name: 'Overview', url: '/guides/deployment/branching' },
|
||||
{ name: 'GitHub integration', url: '/guides/deployment/branching/github-integration' },
|
||||
{ name: 'Branching via GitHub', url: '/guides/deployment/branching/github-integration' },
|
||||
{
|
||||
name: 'Branching 2.0 (Alpha)',
|
||||
url: '/guides/deployment/branching/branching-2',
|
||||
name: 'Branching via dashboard',
|
||||
url: '/guides/deployment/branching/dashboard',
|
||||
},
|
||||
|
||||
{
|
||||
name: 'Working with branches',
|
||||
url: '/guides/deployment/branching/working-with-branches',
|
||||
|
||||
@@ -12,5 +12,5 @@ Supabase branches create separate environments that spin off from your main proj
|
||||
- **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.
|
||||
- **GitHub integration and Branching 2.0**: You can use branching with the GitHub integration, or use Branching 2.0 to manage your branches without Git (in Feature Preview).
|
||||
- **Managing Branches**: You can create, review, and merge branches either automatically via our [GitHub integration](/docs/guides/deployment/branching/github-integration) or directly [through the dashboard](/docs/guides/deployment/branching/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](/docs/guides/deployment/branching/github-integration#seeding) if using the GitHub integration.
|
||||
+10
-10
@@ -1,36 +1,36 @@
|
||||
---
|
||||
title: 'Branching 2.0 (Alpha)'
|
||||
subtitle: 'Create and manage branches without using Git'
|
||||
title: 'Branching via the dashboard'
|
||||
subtitle: 'Create, manage, review, and merge branches directly in the dashboard'
|
||||
---
|
||||
|
||||
Branching 2.0 allows you to create and manage Supabase branches without connecting to a Git repository. This is useful for quick testing, prototyping, or when you prefer to manage your database changes outside of Git.
|
||||
You can create, manage, review, and merge Supabase branches directly via the dashboard. This is useful for quick testing, prototyping, or when you prefer to work in a no-code way. You can also connect a Supabase branch to a GitHub branch at a later time if needed.
|
||||
|
||||
<Admonition type="note" label="Public Alpha">
|
||||
|
||||
Branching 2.0 is currently in public alpha. Features and functionality may change.
|
||||
Branch management via the dashboard is currently in public alpha. Features and functionality may change.
|
||||
|
||||
</Admonition>
|
||||
|
||||
## How Branching 2.0 works
|
||||
## How Branching works
|
||||
|
||||
With Branching 2.0, you can do the following directly from the Supabase dashboard:
|
||||
You can do the following directly from the Supabase dashboard:
|
||||
|
||||
- Create preview branches
|
||||
- Make changes to your public schema or edge functions
|
||||
- Merge these changes back into production when ready
|
||||
- Pull in updates from production
|
||||
|
||||
## Enable Branching 2.0
|
||||
## Enable branch management via the dashboard
|
||||
|
||||
Branching 2.0 is available as a Feature Preview. To enable Branching 2.0 in the Supabase Dashboard:
|
||||
This functionality is currently in beta and requires opting in. To opt in you must enable the feature preview:
|
||||
|
||||
1. Open the user menu by clicking on your user icon in the top right.
|
||||
1. Select **Branching 2.0**.
|
||||
1. Select **Branching via dashboard**.
|
||||
1. Click **Enable feature**.
|
||||
|
||||
## Creating a branch
|
||||
|
||||
Once you've enabled Branching 2.0, you can create a new branch:
|
||||
Once you've enabled the feature, you can create a new branch:
|
||||
|
||||
1. Click the arrows next to the branch name in the top menu bar. (The top menu bar has the format `YOUR_ORGANIZATION / YOUR_PROJECT / CURRENT_BRANCH_NAME`.)
|
||||
2. Click `Create branch`.
|
||||
@@ -14,9 +14,8 @@ export const Branching2Preview = () => {
|
||||
className="rounded border mb-4"
|
||||
/>
|
||||
<p className="text-sm text-foreground-light mb-4">
|
||||
Branching 2.0 introduces a new workflow for managing database branches without having to use
|
||||
Git. Create branches, review changes and merge back into production all through the
|
||||
dashboard. Read the below limitations and our{' '}
|
||||
Create branches, review changes, and merge back into production all through the dashboard.
|
||||
Read the below limitations and our{' '}
|
||||
<InlineLink href="https://supabase.com/docs/guides/platform/branching">
|
||||
branching documentation
|
||||
</InlineLink>{' '}
|
||||
@@ -52,11 +51,10 @@ export const Branching2Preview = () => {
|
||||
<div className="space-y-2 !mt-4">
|
||||
<p className="text-sm">Enabling this preview will:</p>
|
||||
<ul className="list-disc pl-6 text-sm text-foreground-light space-y-1">
|
||||
<li>Enable the new Branching 2.0 workflow for your project.</li>
|
||||
<li>
|
||||
Allow you to create, manage, and merge database branches with improved UI and features.
|
||||
Allow you to create, manage, review, and merge database branches directly via the
|
||||
branches page within the dashboard
|
||||
</li>
|
||||
<li>Access new merge request and deployment management tools.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -10,7 +10,7 @@ export const FEATURE_PREVIEWS = [
|
||||
},
|
||||
{
|
||||
key: LOCAL_STORAGE_KEYS.UI_PREVIEW_BRANCHING_2_0,
|
||||
name: 'Branching 2.0',
|
||||
name: 'Branching via dashboard',
|
||||
discussionsUrl: 'https://github.com/orgs/supabase/discussions/branching-2-0',
|
||||
isNew: true,
|
||||
isPlatformOnly: true,
|
||||
|
||||
@@ -2021,6 +2021,11 @@ module.exports = [
|
||||
source: '/docs/guides/platform/database-usage',
|
||||
destination: '/docs/guides/platform/database-size',
|
||||
},
|
||||
{
|
||||
permanent: true,
|
||||
source: '/docs/guides/deployment/branching/branching-2',
|
||||
destination: '/docs/guides/deployment/branching/dashboard',
|
||||
},
|
||||
{
|
||||
permanent: true,
|
||||
source: '/docs/guides/resources/postgres/dropping-all-tables-in-schema',
|
||||
|
||||
Reference in new issue
Block a user