Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
cli/cmd/branches.go at develop · paramountric/cli · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
See all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
paramountric
cli
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
More
items
Files
Expand file tree
develop
Breadcrumbs
cli
/
cmd
/
branches.go
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
228 lines (214 loc) · 6.71 KB
develop
Breadcrumbs
cli
/
cmd
/
branches.go
Copy path
Top
File metadata and controls
Code
Blame
228 lines (214 loc) · 6.71 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
package
cmd
import
(
"context"
"fmt"
"os"
"github.com/go-errors/errors"
"github.com/spf13/afero"
"github.com/spf13/cobra"
"github.com/supabase/cli/internal/branches/create"
"github.com/supabase/cli/internal/branches/delete"
"github.com/supabase/cli/internal/branches/disable"
"github.com/supabase/cli/internal/branches/get"
"github.com/supabase/cli/internal/branches/list"
"github.com/supabase/cli/internal/branches/update"
"github.com/supabase/cli/internal/gen/keys"
"github.com/supabase/cli/internal/utils"
"github.com/supabase/cli/internal/utils/flags"
"github.com/supabase/cli/pkg/api"
)
var
(
branchesCmd
=
&
cobra.
Command
{
GroupID
:
groupManagementAPI
,
Use
:
"branches"
,
Short
:
"Manage Supabase preview branches"
,
}
branchRegion
=
utils.
EnumFlag
{
Allowed
:
awsRegions
(),
}
persistent
bool
branchCreateCmd
=
&
cobra.
Command
{
Use
:
"create [name]"
,
Short
:
"Create a preview branch"
,
Long
:
"Create a preview branch for the linked project."
,
Args
:
cobra
.
MaximumNArgs
(
1
),
RunE
:
func
(
cmd
*
cobra.
Command
,
args
[]
string
)
error
{
var
body
api.
CreateBranchBody
if
len
(
args
)
>
0
{
body
.
BranchName
=
args
[
0
]
}
cmdFlags
:=
cmd
.
Flags
()
if
cmdFlags
.
Changed
(
"region"
) {
body
.
Region
=
&
branchRegion
.
Value
}
if
cmdFlags
.
Changed
(
"size"
) {
body
.
DesiredInstanceSize
=
(
*
api
.
DesiredInstanceSize
)(
&
size
.
Value
)
}
if
cmdFlags
.
Changed
(
"persistent"
) {
body
.
Persistent
=
&
persistent
}
return
create
.
Run
(
cmd
.
Context
(),
body
,
afero
.
NewOsFs
())
},
}
branchListCmd
=
&
cobra.
Command
{
Use
:
"list"
,
Short
:
"List all preview branches"
,
Long
:
"List all preview branches of the linked project."
,
Args
:
cobra
.
NoArgs
,
RunE
:
func
(
cmd
*
cobra.
Command
,
args
[]
string
)
error
{
return
list
.
Run
(
cmd
.
Context
(),
afero
.
NewOsFs
())
},
}
branchId
string
branchGetCmd
=
&
cobra.
Command
{
Use
:
"get [branch-id]"
,
Short
:
"Retrieve details of a preview branch"
,
Long
:
"Retrieve details of the specified preview branch."
,
Args
:
cobra
.
MaximumNArgs
(
1
),
RunE
:
func
(
cmd
*
cobra.
Command
,
args
[]
string
)
error
{
ctx
:=
cmd
.
Context
()
if
len
(
args
)
==
0
{
if
err
:=
promptBranchId
(
ctx
,
flags
.
ProjectRef
);
err
!=
nil
{
return
err
}
}
else
{
branchId
=
args
[
0
]
}
return
get
.
Run
(
ctx
,
branchId
)
},
}
branchStatus
=
utils.
EnumFlag
{
Allowed
: []
string
{
string
(
api
.
BranchResponseStatusRUNNINGMIGRATIONS
),
string
(
api
.
BranchResponseStatusMIGRATIONSPASSED
),
string
(
api
.
BranchResponseStatusMIGRATIONSFAILED
),
string
(
api
.
BranchResponseStatusFUNCTIONSDEPLOYED
),
string
(
api
.
BranchResponseStatusFUNCTIONSFAILED
),
},
}
branchName
string
gitBranch
string
branchUpdateCmd
=
&
cobra.
Command
{
Use
:
"update [branch-id]"
,
Short
:
"Update a preview branch"
,
Long
:
"Update a preview branch by its ID."
,
Args
:
cobra
.
MaximumNArgs
(
1
),
RunE
:
func
(
cmd
*
cobra.
Command
,
args
[]
string
)
error
{
cmdFlags
:=
cmd
.
Flags
()
var
body
api.
UpdateBranchBody
if
cmdFlags
.
Changed
(
"name"
) {
body
.
BranchName
=
&
branchName
}
if
cmdFlags
.
Changed
(
"git-branch"
) {
body
.
GitBranch
=
&
gitBranch
}
if
cmdFlags
.
Changed
(
"persistent"
) {
body
.
Persistent
=
&
persistent
}
if
cmdFlags
.
Changed
(
"status"
) {
body
.
Status
=
(
*
api
.
UpdateBranchBodyStatus
)(
&
branchStatus
.
Value
)
}
ctx
:=
cmd
.
Context
()
if
len
(
args
)
==
0
{
if
err
:=
promptBranchId
(
ctx
,
flags
.
ProjectRef
);
err
!=
nil
{
return
err
}
}
else
{
branchId
=
args
[
0
]
}
return
update
.
Run
(
cmd
.
Context
(),
branchId
,
body
,
afero
.
NewOsFs
())
},
}
branchDeleteCmd
=
&
cobra.
Command
{
Use
:
"delete [branch-id]"
,
Short
:
"Delete a preview branch"
,
Long
:
"Delete a preview branch by its ID."
,
Args
:
cobra
.
MaximumNArgs
(
1
),
RunE
:
func
(
cmd
*
cobra.
Command
,
args
[]
string
)
error
{
ctx
:=
cmd
.
Context
()
if
len
(
args
)
==
0
{
if
err
:=
promptBranchId
(
ctx
,
flags
.
ProjectRef
);
err
!=
nil
{
return
err
}
}
else
{
branchId
=
args
[
0
]
}
return
delete
.
Run
(
ctx
,
branchId
)
},
}
branchDisableCmd
=
&
cobra.
Command
{
Use
:
"disable"
,
Short
:
"Disable preview branching"
,
Long
:
"Disable preview branching for the linked project."
,
RunE
:
func
(
cmd
*
cobra.
Command
,
args
[]
string
)
error
{
return
disable
.
Run
(
cmd
.
Context
(),
afero
.
NewOsFs
())
},
}
)
func
init
() {
branchFlags
:=
branchesCmd
.
PersistentFlags
()
branchFlags
.
StringVar
(
&
flags
.
ProjectRef
,
"project-ref"
,
""
,
"Project ref of the Supabase project."
)
createFlags
:=
branchCreateCmd
.
Flags
()
createFlags
.
Var
(
&
branchRegion
,
"region"
,
"Select a region to deploy the branch database."
)
createFlags
.
Var
(
&
size
,
"size"
,
"Select a desired instance size for the branch database."
)
createFlags
.
BoolVar
(
&
persistent
,
"persistent"
,
false
,
"Whether to create a persistent branch."
)
branchesCmd
.
AddCommand
(
branchCreateCmd
)
branchesCmd
.
AddCommand
(
branchListCmd
)
branchesCmd
.
AddCommand
(
branchGetCmd
)
updateFlags
:=
branchUpdateCmd
.
Flags
()
updateFlags
.
StringVar
(
&
branchName
,
"name"
,
""
,
"Rename the preview branch."
)
updateFlags
.
StringVar
(
&
gitBranch
,
"git-branch"
,
""
,
"Change the associated git branch."
)
updateFlags
.
BoolVar
(
&
persistent
,
"persistent"
,
false
,
"Switch between ephemeral and persistent branch."
)
updateFlags
.
Var
(
&
branchStatus
,
"status"
,
"Override the current branch status."
)
branchesCmd
.
AddCommand
(
branchUpdateCmd
)
branchesCmd
.
AddCommand
(
branchDeleteCmd
)
branchesCmd
.
AddCommand
(
branchDisableCmd
)
rootCmd
.
AddCommand
(
branchesCmd
)
}
func
promptBranchId
(
ctx
context.
Context
,
ref
string
)
error
{
resp
,
err
:=
utils
.
GetSupabase
().
V1ListAllBranchesWithResponse
(
ctx
,
ref
)
if
err
!=
nil
{
return
errors
.
Errorf
(
"failed to list preview branches: %w"
,
err
)
}
if
resp
.
JSON200
==
nil
{
return
errors
.
New
(
"Unexpected error listing preview branches: "
+
string
(
resp
.
Body
))
}
console
:=
utils
.
NewConsole
()
if
!
console
.
IsTTY
{
// Fallback to current git branch on GHA
gitBranch
:=
keys
.
GetGitBranch
(
afero
.
NewOsFs
())
title
:=
"Enter the name of your branch: "
if
len
(
gitBranch
)
>
0
{
title
=
fmt
.
Sprintf
(
"%-2s (or leave blank to use %s): "
,
title
,
utils
.
Aqua
(
gitBranch
))
}
if
name
,
err
:=
console
.
PromptText
(
ctx
,
title
);
err
!=
nil
{
return
err
}
else
if
len
(
name
)
>
0
{
gitBranch
=
name
}
if
len
(
gitBranch
)
==
0
{
return
errors
.
New
(
"git branch cannot be empty"
)
}
for
_
,
branch
:=
range
*
resp
.
JSON200
{
if
branch
.
Name
==
gitBranch
{
branchId
=
branch
.
Id
return
nil
}
}
return
errors
.
Errorf
(
"Branch not found: %s"
,
gitBranch
)
}
items
:=
make
([]utils.
PromptItem
,
len
(
*
resp
.
JSON200
))
for
i
,
branch
:=
range
*
resp
.
JSON200
{
items
[
i
]
=
utils.
PromptItem
{
Summary
:
branch
.
Name
,
Details
:
branch
.
Id
,
}
}
title
:=
"Select a branch:"
choice
,
err
:=
utils
.
PromptChoice
(
ctx
,
title
,
items
)
if
err
==
nil
{
branchId
=
choice
.
Details
fmt
.
Fprintln
(
os
.
Stderr
,
"Selected branch ID:"
,
branchId
)
}
return
err
}
You can’t perform that action at this time.