Skip to content

Commit d0972be

Browse files
Update branch framing (supabase#37673)
* update branch framing * shorten preview name * Update apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx Co-authored-by: Chris Chinchilla <[email protected]> * Update apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx Co-authored-by: Chris Chinchilla <[email protected]> * Update apps/docs/content/guides/deployment/branching/branching-2.mdx Co-authored-by: Chris Chinchilla <[email protected]> * Update apps/docs/content/guides/deployment/branching/branching-2.mdx Co-authored-by: Chris Chinchilla <[email protected]> * Update apps/docs/content/guides/deployment/branching/branching-2.mdx Co-authored-by: Chris Chinchilla <[email protected]> * Update apps/docs/content/guides/deployment/branching.mdx Co-authored-by: Chris Chinchilla <[email protected]> * update name and add redirect --------- Co-authored-by: Chris Chinchilla <[email protected]>
1 parent 8ea9469 commit d0972be

File tree

6 files changed

+25
-21
lines changed

6 files changed

+25
-21
lines changed

apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2477,11 +2477,12 @@ export const deployment: NavMenuConstant = {
24772477
url: undefined,
24782478
items: [
24792479
{ name: 'Overview', url: '/guides/deployment/branching' },
2480-
{ name: 'GitHub integration', url: '/guides/deployment/branching/github-integration' },
2480+
{ name: 'Branching via GitHub', url: '/guides/deployment/branching/github-integration' },
24812481
{
2482-
name: 'Branching 2.0 (Alpha)',
2483-
url: '/guides/deployment/branching/branching-2',
2482+
name: 'Branching via dashboard',
2483+
url: '/guides/deployment/branching/dashboard',
24842484
},
2485+
24852486
{
24862487
name: 'Working with branches',
24872488
url: '/guides/deployment/branching/working-with-branches',

apps/docs/content/guides/deployment/branching.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Supabase branches create separate environments that spin off from your main proj
1212
- **Separate Environments**: Each branch is a separate environment with its own Supabase instance and API credentials.
1313
- **Preview Branches**: You can create multiple Preview Branches for testing.
1414
- **Persistent Branches**: Persistent branches are long-lived branches. They aren't automatically paused or deleted due to non-inactivity or merging.
15-
- **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).
15+
- **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.
1616
- **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.

apps/docs/content/guides/deployment/branching/branching-2.mdx renamed to apps/docs/content/guides/deployment/branching/dashboard.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
---
2-
title: 'Branching 2.0 (Alpha)'
3-
subtitle: 'Create and manage branches without using Git'
2+
title: 'Branching via the dashboard'
3+
subtitle: 'Create, manage, review, and merge branches directly in the dashboard'
44
---
55

6-
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.
6+
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.
77

88
<Admonition type="note" label="Public Alpha">
99

10-
Branching 2.0 is currently in public alpha. Features and functionality may change.
10+
Branch management via the dashboard is currently in public alpha. Features and functionality may change.
1111

1212
</Admonition>
1313

14-
## How Branching 2.0 works
14+
## How Branching works
1515

16-
With Branching 2.0, you can do the following directly from the Supabase dashboard:
16+
You can do the following directly from the Supabase dashboard:
1717

1818
- Create preview branches
1919
- Make changes to your public schema or edge functions
2020
- Merge these changes back into production when ready
2121
- Pull in updates from production
2222

23-
## Enable Branching 2.0
23+
## Enable branch management via the dashboard
2424

25-
Branching 2.0 is available as a Feature Preview. To enable Branching 2.0 in the Supabase Dashboard:
25+
This functionality is currently in beta and requires opting in. To opt in you must enable the feature preview:
2626

2727
1. Open the user menu by clicking on your user icon in the top right.
28-
1. Select **Branching 2.0**.
28+
1. Select **Branching via dashboard**.
2929
1. Click **Enable feature**.
3030

3131
## Creating a branch
3232

33-
Once you've enabled Branching 2.0, you can create a new branch:
33+
Once you've enabled the feature, you can create a new branch:
3434

3535
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`.)
3636
2. Click `Create branch`.

apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ export const Branching2Preview = () => {
1414
className="rounded border mb-4"
1515
/>
1616
<p className="text-sm text-foreground-light mb-4">
17-
Branching 2.0 introduces a new workflow for managing database branches without having to use
18-
Git. Create branches, review changes and merge back into production all through the
19-
dashboard. Read the below limitations and our{' '}
17+
Create branches, review changes, and merge back into production all through the dashboard.
18+
Read the below limitations and our{' '}
2019
<InlineLink href="https://supabase.com/docs/guides/platform/branching">
2120
branching documentation
2221
</InlineLink>{' '}
@@ -52,11 +51,10 @@ export const Branching2Preview = () => {
5251
<div className="space-y-2 !mt-4">
5352
<p className="text-sm">Enabling this preview will:</p>
5453
<ul className="list-disc pl-6 text-sm text-foreground-light space-y-1">
55-
<li>Enable the new Branching 2.0 workflow for your project.</li>
5654
<li>
57-
Allow you to create, manage, and merge database branches with improved UI and features.
55+
Allow you to create, manage, review, and merge database branches directly via the
56+
branches page within the dashboard
5857
</li>
59-
<li>Access new merge request and deployment management tools.</li>
6058
</ul>
6159
</div>
6260
</div>

apps/studio/components/interfaces/App/FeaturePreview/FeaturePreview.constants.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const FEATURE_PREVIEWS = [
1010
},
1111
{
1212
key: LOCAL_STORAGE_KEYS.UI_PREVIEW_BRANCHING_2_0,
13-
name: 'Branching 2.0',
13+
name: 'Branching via dashboard',
1414
discussionsUrl: 'https://github.com/orgs/supabase/discussions/branching-2-0',
1515
isNew: true,
1616
isPlatformOnly: true,

apps/www/lib/redirects.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2021,6 +2021,11 @@ module.exports = [
20212021
source: '/docs/guides/platform/database-usage',
20222022
destination: '/docs/guides/platform/database-size',
20232023
},
2024+
{
2025+
permanent: true,
2026+
source: '/docs/guides/deployment/branching/branching-2',
2027+
destination: '/docs/guides/deployment/branching/dashboard',
2028+
},
20242029
{
20252030
permanent: true,
20262031
source: '/docs/guides/resources/postgres/dropping-all-tables-in-schema',

0 commit comments

Comments
 (0)