conf: add new config option for default branch name (#7291)

Co-authored-by: Vamsi Atluri <[email protected]>
Co-authored-by: Joe Chen <[email protected]>

CHANGELOG.md

@@ -11,6 +11,7 @@ All notable changes to Gogs are documented in this file.
 - New API endpoint `PUT /repos/:owner/:repo/contents/:path` for creating and update repository contents. [#5967](https://github.com/gogs/gogs/issues/5967)
 - New configuration option `[git.timeout] DIFF` for customizing operation timeout of `git diff`. [#6315](https://github.com/gogs/gogs/issues/6315)
 - New configuration option `[server] SSH_SERVER_MACS` for setting list of accepted MACs for connections to builtin SSH server. [#6434](https://github.com/gogs/gogs/issues/6434)
+- New configuration option `[repository] DEFAULT_BRANCH` for setting default branch name for new repositories. [#7291](https://github.com/gogs/gogs/issues/7291)
 - Support specifying custom schema for PostgreSQL. [#6695](https://github.com/gogs/gogs/pull/6695)
 - Support rendering Mermaid diagrams in Markdown. [#6776](https://github.com/gogs/gogs/pull/6776)
 - Docker: Allow passing extra arguments to the `backup` command. [#7060](https://github.com/gogs/gogs/pull/7060)

conf/app.ini

@@ -115,6 +115,8 @@ ENABLE_RAW_FILE_RENDER_MODE = false
 ; fetch request. Usually, the value depend of how many CPU (cores) you have. If
 ; the value is non-positive, it matches the number of CPUs available to the application.
 COMMITS_FETCH_CONCURRENCY = 0
+; Default branch name when creating new repositories.
+DEFAULT_BRANCH = master
 
 [repository.editor]
 ; List of file extensions that should have line wraps in the CodeMirror editor.

conf/locale/locale_en-US.ini

@@ -88,6 +88,7 @@ log_root_path = Log Path
 log_root_path_helper = Directory to write log files to.
 enable_console_mode = Enable Console Mode
 enable_console_mode_popup = In addition to file mode, also print logs to console.
+default_branch = Default Branch
 
 optional_title = Optional Settings
 email_title = Email Service Settings

go.mod

@@ -17,7 +17,7 @@ require (
 	github.com/go-macaron/toolbox v0.0.0-20190813233741-94defb8383c6
 	github.com/gogs/chardet v0.0.0-20150115103509-2404f7772561
 	github.com/gogs/cron v0.0.0-20171120032916-9f6c956d3e14
-	github.com/gogs/git-module v1.7.1
+	github.com/gogs/git-module v1.7.2
 	github.com/gogs/go-gogs-client v0.0.0-20200128182646-c69cb7680fd4
 	github.com/gogs/go-libravatar v0.0.0-20191106065024-33a75213d0a0
 	github.com/gogs/minwinsvc v0.0.0-20170301035411-95be6356811a

go.sum

@@ -153,8 +153,8 @@ github.com/gogs/chardet v0.0.0-20150115103509-2404f7772561 h1:aBzukfDxQlCTVS0NBU
 github.com/gogs/chardet v0.0.0-20150115103509-2404f7772561/go.mod h1:Pcatq5tYkCW2Q6yrR2VRHlbHpZ/R4/7qyL1TCF7vl14=
 github.com/gogs/cron v0.0.0-20171120032916-9f6c956d3e14 h1:yXtpJr/LV6PFu4nTLgfjQdcMdzjbqqXMEnHfq0Or6p8=
 github.com/gogs/cron v0.0.0-20171120032916-9f6c956d3e14/go.mod h1:jPoNZLWDAqA5N3G5amEoiNbhVrmM+ZQEcnQvNQ2KaZk=
-github.com/gogs/git-module v1.7.1 h1:KzK3oZ9YMVV6HyWxStFTTcFpCKsFRb8424qKTpa59XM=
-github.com/gogs/git-module v1.7.1/go.mod h1:Y3rsSqtFZEbn7lp+3gWf42GKIY1eNTtLt7JrmOy0yAQ=
+github.com/gogs/git-module v1.7.2 h1:9SJ5imgMRtPrqu2ubmn9Ll5t7zZPftlNfnPOK32fFsQ=
+github.com/gogs/git-module v1.7.2/go.mod h1:Y3rsSqtFZEbn7lp+3gWf42GKIY1eNTtLt7JrmOy0yAQ=
 github.com/gogs/go-gogs-client v0.0.0-20200128182646-c69cb7680fd4 h1:C7NryI/RQhsIWwC2bHN601P1wJKeuQ6U/UCOYTn3Cic=
 github.com/gogs/go-gogs-client v0.0.0-20200128182646-c69cb7680fd4/go.mod h1:fR6z1Ie6rtF7kl/vBYMfgD5/G5B1blui7z426/sj2DU=
 github.com/gogs/go-libravatar v0.0.0-20191106065024-33a75213d0a0 h1:K02vod+sn3M1OOkdqi2tPxN2+xESK4qyITVQ3JkGEv4=

internal/conf/static.go

@@ -321,6 +321,7 @@ type RepositoryOpts struct {
 	EnableLocalPathMigration bool
 	EnableRawFileRenderMode  bool
 	CommitsFetchConcurrency  int
+	DefaultBranch            string
 
 	// Repository editor settings
 	Editor struct {

internal/conf/testdata/TestInit.golden.ini

@@ -44,6 +44,7 @@ DISABLE_HTTP_GIT=false
 ENABLE_LOCAL_PATH_MIGRATION=false
 ENABLE_RAW_FILE_RENDER_MODE=false
 COMMITS_FETCH_CONCURRENCY=0
+DEFAULT_BRANCH=master
 
 [repository.editor]
 LINE_WRAP_EXTENSIONS=.txt,.md,.markdown,.mdown,.mkd

internal/db/repo.go

@@ -223,7 +223,7 @@ func (repo *Repository) AfterSet(colName string, _ xorm.Cell) {
 	case "default_branch":
 		// FIXME: use db migration to solve all at once.
 		if repo.DefaultBranch == "" {
-			repo.DefaultBranch = "master"
+			repo.DefaultBranch = conf.Repository.DefaultBranch
 		}
 	case "num_closed_issues":
 		repo.NumOpenIssues = repo.NumIssues - repo.NumClosedIssues
@@ -975,10 +975,9 @@ func getRepoInitFile(tp, name string) ([]byte, error) {
 
 func prepareRepoCommit(repo *Repository, tmpDir, repoPath string, opts CreateRepoOptionsLegacy) error {
 	// Clone to temporary path and do the init commit.
-	_, stderr, err := process.Exec(
-		fmt.Sprintf("initRepository(git clone): %s", repoPath), "git", "clone", repoPath, tmpDir)
+	err := git.Clone(repoPath, tmpDir, git.CloneOptions{})
 	if err != nil {
-		return fmt.Errorf("git clone: %v - %s", err, stderr)
+		return errors.Wrap(err, "clone")
 	}
 
 	// README
@@ -1049,6 +1048,18 @@ func initRepository(e Engine, repoPath string, doer *User, repo *Repository, opt
 		return fmt.Errorf("createDelegateHooks: %v", err)
 	}
 
+	// Set default branch
+	_, err = git.SymbolicRef(
+		repoPath,
+		git.SymbolicRefOptions{
+			Name: "HEAD",
+			Ref:  git.RefsHeads + conf.Repository.DefaultBranch,
+		},
+	)
+	if err != nil {
+		return errors.Wrap(err, "set default branch")
+	}
+
 	tmpDir := filepath.Join(os.TempDir(), "gogs-"+repo.Name+"-"+com.ToStr(time.Now().Nanosecond()))
 
 	// Initialize repository according to user's choice.
@@ -1086,7 +1097,7 @@ func initRepository(e Engine, repoPath string, doer *User, repo *Repository, opt
 		repo.IsBare = true
 	}
 
-	repo.DefaultBranch = "master"
+	repo.DefaultBranch = conf.Repository.DefaultBranch
 	if err = updateRepository(e, repo, false); err != nil {
 		return fmt.Errorf("updateRepository: %v", err)
 	}

internal/form/user.go

@@ -31,6 +31,7 @@ type Install struct {
 	AppUrl              string `binding:"Required"`
 	LogRootPath         string `binding:"Required"`
 	EnableConsoleMode   bool
+	DefaultBranch       string
 
 	SMTPHost        string
 	SMTPFrom        string

internal/route/install.go

@@ -161,6 +161,7 @@ func Install(c *context.Context) {
 	f.HTTPPort = conf.Server.HTTPPort
 	f.AppUrl = conf.Server.ExternalURL
 	f.LogRootPath = conf.Log.RootPath
+	f.DefaultBranch = conf.Repository.DefaultBranch
 
 	// E-mail service settings
 	if conf.Email.Enabled {
@@ -321,6 +322,7 @@ func InstallPost(c *context.Context, f form.Install) {
 
 	cfg.Section("").Key("BRAND_NAME").SetValue(f.AppName)
 	cfg.Section("repository").Key("ROOT").SetValue(f.RepoRootPath)
+	cfg.Section("repository").Key("DEFAULT_BRANCH").SetValue(f.DefaultBranch)
 	cfg.Section("").Key("RUN_USER").SetValue(f.RunUser)
 	cfg.Section("server").Key("DOMAIN").SetValue(f.Domain)
 	cfg.Section("server").Key("HTTP_PORT").SetValue(f.HTTPPort)

templates/install.tmpl

@@ -130,7 +130,10 @@
 							<input name="enable_console_mode" type="checkbox" {{if .enable_console_mode}}checked{{end}}>
 						</div>
 					</div>
-
+					<div class="inline required field">
+						<label for="default_branch">{{.i18n.Tr "install.default_branch"}}</label>
+						<input id="default_branch" name="default_branch" value="{{.default_branch}}" required>
+					</div>
 
 					<!-- Optional Settings -->
 					<h4 class="ui dividing header">{{.i18n.Tr "install.optional_title"}}</h4>

templates/repo/bare.tmpl

@@ -39,7 +39,7 @@ git init
 git add README.md
 git commit -m "first commit"
 git remote add origin <span class="clone-url">{{if $.DisableSSH}}{{$.CloneLink.HTTPS}}{{else}}{{$.CloneLink.SSH}}{{end}}</span>
-git push -u origin master</code></pre>
+git push -u origin {{ $.Repository.DefaultBranch }}</code></pre>
 							</div>
 						</div>
 						<div class="ui divider"></div>
@@ -48,7 +48,7 @@ git push -u origin master</code></pre>
 							<h3>{{.i18n.Tr "repo.push_exist_repo"}}</h3>
 							<div class="markdown">
 								<pre><code>git remote add origin <span class="clone-url">{{if $.DisableSSH}}{{$.CloneLink.HTTPS}}{{else}}{{$.CloneLink.SSH}}{{end}}</span>
-git push -u origin master</code></pre>
+git push -u origin {{ $.Repository.DefaultBranch }}</code></pre>
 							</div>
 						</div>
 					{{else}}