feat: deprecate data-folder and expose branch flags (#966)

Author: dbarrosop

clienv/clienv.go

@@ -67,7 +67,6 @@ func FromCLI(cCtx *cli.Context) *CliEnv {
 			cwd,
 			cCtx.String(flagRootFolder),
 			cCtx.String(flagDotNhostFolder),
-			cCtx.String(flagDataFolder),
 			cCtx.String(flagNhostFolder),
 		),
 		authURL:        cCtx.String(flagAuthURL),

clienv/filesystem.go

@@ -9,18 +9,16 @@ type PathStructure struct {
 	workingDir     string
 	root           string
 	dotNhostFolder string
-	dataFolder     string
 	nhostFolder    string
 }
 
 func NewPathStructure(
-	workingDir, root, dotNhostFolder, dataFolder, nhostFolder string,
+	workingDir, root, dotNhostFolder, nhostFolder string,
 ) *PathStructure {
 	return &PathStructure{
 		workingDir:     workingDir,
 		root:           root,
 		dotNhostFolder: dotNhostFolder,
-		dataFolder:     dataFolder,
 		nhostFolder:    nhostFolder,
 	}
 }
@@ -37,10 +35,6 @@ func (p PathStructure) DotNhostFolder() string {
 	return p.dotNhostFolder
 }
 
-func (p PathStructure) DataFolder() string {
-	return p.dataFolder
-}
-
 func (p PathStructure) NhostFolder() string {
 	return p.nhostFolder
 }

clienv/flags.go

@@ -15,7 +15,6 @@ const (
 	flagBranch         = "branch"
 	flagProjectName    = "project-name"
 	flagRootFolder     = "root-folder"
-	flagDataFolder     = "data-folder"
 	flagNhostFolder    = "nhost-folder"
 	flagDotNhostFolder = "dot-nhost-folder"
 	flagLocalSubdomain = "local-subdomain"
@@ -38,7 +37,7 @@ func getGitBranchName() string {
 	return head.Name().Short()
 }
 
-func Flags() ([]cli.Flag, error) { //nolint:funlen
+func Flags() ([]cli.Flag, error) {
 	fullWorkingDir, err := os.Getwd()
 	if err != nil {
 		return nil, fmt.Errorf("failed to get working directory: %w", err)
@@ -48,7 +47,6 @@ func Flags() ([]cli.Flag, error) { //nolint:funlen
 
 	workingDir := "."
 	dotNhostFolder := filepath.Join(workingDir, ".nhost")
-	dataFolder := filepath.Join(dotNhostFolder, "data", branch)
 	nhostFolder := filepath.Join(workingDir, "nhost")
 
 	return []cli.Flag{
@@ -68,10 +66,10 @@ func Flags() ([]cli.Flag, error) { //nolint:funlen
 		},
 		&cli.StringFlag{ //nolint:exhaustruct
 			Name:    flagBranch,
-			Usage:   "Git branch name",
+			Usage:   "Git branch name. If not set, it will be detected from the current git repository. This flag is used to dynamically create docker volumes for each branch. If you want to have a static volume name or if you are not using git, set this flag to a static value.", //nolint:lll
 			EnvVars: []string{"BRANCH"},
 			Value:   branch,
-			Hidden:  true,
+			Hidden:  false,
 		},
 		&cli.StringFlag{ //nolint:exhaustruct
 			Name:     flagRootFolder,
@@ -87,13 +85,6 @@ func Flags() ([]cli.Flag, error) { //nolint:funlen
 			Value:    dotNhostFolder,
 			Category: "Project structure",
 		},
-		&cli.StringFlag{ //nolint:exhaustruct
-			Name:     flagDataFolder,
-			Usage:    "Data folder to persist data\n\t",
-			EnvVars:  []string{"NHOST_DATA_FOLDER"},
-			Value:    dataFolder,
-			Category: "Project structure",
-		},
 		&cli.StringFlag{ //nolint:exhaustruct
 			Name:     flagNhostFolder,
 			Usage:    "Path to nhost folder\n\t",

cmd/config/validate_test.go

@@ -254,7 +254,6 @@ func TestValidate(t *testing.T) {
 					".",
 					filepath.Join("testdata", "validate", tc.path),
 					filepath.Join("testdata", "validate", tc.path, ".nhost"),
-					filepath.Join("testdata", "validate", tc.path, ".nhost", "data"),
 					filepath.Join("testdata", "validate", tc.path, "nhost"),
 				),
 				"fakeauthurl",

cmd/dev/up.go

@@ -363,7 +363,6 @@ func up( //nolint:funlen,cyclop
 		httpPort,
 		useTLS,
 		postgresPort,
-		ce.Path.DataFolder(),
 		ce.Path.NhostFolder(),
 		ce.Path.DotNhostFolder(),
 		ce.Path.Root(),

dockercompose/compose.go

@@ -515,7 +515,6 @@ func getServices( //nolint: funlen,cyclop
 	httpPort uint,
 	useTLS bool,
 	postgresPort uint,
-	dataFolder string,
 	nhostFolder string,
 	dotNhostFolder string,
 	rootFolder string,
@@ -535,6 +534,7 @@ func getServices( //nolint: funlen,cyclop
 	}
 
 	pgVolumeName := "pgdata_" + sanitizeBranch(branch)
+	dataFolder := filepath.Join(dotNhostFolder, "data")
 	postgres, err := postgres(cfg, subdomain, postgresPort, dataFolder, pgVolumeName)
 	if err != nil {
 		return nil, err
@@ -636,7 +636,6 @@ func ComposeFileFromConfig( //nolint:funlen
 	httpPort uint,
 	useTLS bool,
 	postgresPort uint,
-	dataFolder string,
 	nhostFolder string,
 	dotNhostFolder string,
 	rootFolder string,
@@ -655,7 +654,6 @@ func ComposeFileFromConfig( //nolint:funlen
 		httpPort,
 		useTLS,
 		postgresPort,
-		dataFolder,
 		nhostFolder,
 		dotNhostFolder,
 		rootFolder,