Skip to content

Commit a33ff82

Browse files
authored
[refactor] Use const for wiki DefaultBranch (#21466)
just a nit, that will make it easier to change things and we now have a single source of truth
1 parent 677af6a commit a33ff82

File tree

3 files changed

+21
-16
lines changed

3 files changed

+21
-16
lines changed

routers/web/repo/wiki.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ func findWikiRepoCommit(ctx *context.Context) (*git.Repository, *git.Commit, err
9999
return nil, nil, err
100100
}
101101

102-
commit, err := wikiRepo.GetBranchCommit("master")
102+
commit, err := wikiRepo.GetBranchCommit(wiki_service.DefaultBranch)
103103
if err != nil {
104104
return wikiRepo, nil, err
105105
}
@@ -302,7 +302,7 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
302302
ctx.Data["toc"] = rctx.TableOfContents
303303

304304
// get commit count - wiki revisions
305-
commitsCount, _ := wikiRepo.FileCommitsCount("master", pageFilename)
305+
commitsCount, _ := wikiRepo.FileCommitsCount(wiki_service.DefaultBranch, pageFilename)
306306
ctx.Data["CommitCount"] = commitsCount
307307

308308
return wikiRepo, entry
@@ -351,7 +351,7 @@ func renderRevisionPage(ctx *context.Context) (*git.Repository, *git.TreeEntry)
351351
ctx.Data["footerContent"] = ""
352352

353353
// get commit count - wiki revisions
354-
commitsCount, _ := wikiRepo.FileCommitsCount("master", pageFilename)
354+
commitsCount, _ := wikiRepo.FileCommitsCount(wiki_service.DefaultBranch, pageFilename)
355355
ctx.Data["CommitCount"] = commitsCount
356356

357357
// get page
@@ -361,7 +361,7 @@ func renderRevisionPage(ctx *context.Context) (*git.Repository, *git.TreeEntry)
361361
}
362362

363363
// get Commit Count
364-
commitsHistory, err := wikiRepo.CommitsByFileAndRange("master", pageFilename, page)
364+
commitsHistory, err := wikiRepo.CommitsByFileAndRange(wiki_service.DefaultBranch, pageFilename, page)
365365
if err != nil {
366366
if wikiRepo != nil {
367367
wikiRepo.Close()

services/wiki/wiki.go

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ var (
3030
wikiWorkingPool = sync.NewExclusivePool()
3131
)
3232

33+
const (
34+
DefaultRemote = "origin"
35+
DefaultBranch = "master"
36+
)
37+
3338
func nameAllowed(name string) error {
3439
if util.IsStringInSlice(name, reservedWikiNames) {
3540
return repo_model.ErrWikiReservedName{
@@ -81,7 +86,7 @@ func InitWiki(ctx context.Context, repo *repo_model.Repository) error {
8186
return fmt.Errorf("InitRepository: %v", err)
8287
} else if err = repo_module.CreateDelegateHooks(repo.WikiPath()); err != nil {
8388
return fmt.Errorf("createDelegateHooks: %v", err)
84-
} else if _, _, err = git.NewCommand(ctx, "symbolic-ref", "HEAD", git.BranchPrefix+"master").RunStdString(&git.RunOpts{Dir: repo.WikiPath()}); err != nil {
89+
} else if _, _, err = git.NewCommand(ctx, "symbolic-ref", "HEAD", git.BranchPrefix+DefaultBranch).RunStdString(&git.RunOpts{Dir: repo.WikiPath()}); err != nil {
8590
return fmt.Errorf("unable to set default wiki branch to master: %v", err)
8691
}
8792
return nil
@@ -94,7 +99,7 @@ func prepareWikiFileName(gitRepo *git.Repository, wikiName string) (bool, string
9499
escaped := NameToFilename(wikiName)
95100

96101
// Look for both files
97-
filesInIndex, err := gitRepo.LsTree("master", unescaped, escaped)
102+
filesInIndex, err := gitRepo.LsTree(DefaultBranch, unescaped, escaped)
98103
if err != nil {
99104
if strings.Contains(err.Error(), "Not a valid object name master") {
100105
return false, escaped, nil
@@ -130,7 +135,7 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
130135
return fmt.Errorf("InitWiki: %v", err)
131136
}
132137

133-
hasMasterBranch := git.IsBranchExist(ctx, repo.WikiPath(), "master")
138+
hasMasterBranch := git.IsBranchExist(ctx, repo.WikiPath(), DefaultBranch)
134139

135140
basePath, err := repo_module.CreateTemporaryPath("update-wiki")
136141
if err != nil {
@@ -148,7 +153,7 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
148153
}
149154

150155
if hasMasterBranch {
151-
cloneOpts.Branch = "master"
156+
cloneOpts.Branch = DefaultBranch
152157
}
153158

154159
if err := git.Clone(ctx, repo.WikiPath(), basePath, cloneOpts); err != nil {
@@ -246,8 +251,8 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
246251
}
247252

248253
if err := git.Push(gitRepo.Ctx, basePath, git.PushOptions{
249-
Remote: "origin",
250-
Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, "master"),
254+
Remote: DefaultRemote,
255+
Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, DefaultBranch),
251256
Env: repo_module.FullPushingEnvironment(
252257
doer,
253258
doer,
@@ -299,7 +304,7 @@ func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
299304
if err := git.Clone(ctx, repo.WikiPath(), basePath, git.CloneRepoOptions{
300305
Bare: true,
301306
Shared: true,
302-
Branch: "master",
307+
Branch: DefaultBranch,
303308
}); err != nil {
304309
log.Error("Failed to clone repository: %s (%v)", repo.FullName(), err)
305310
return fmt.Errorf("Failed to clone repository: %s (%v)", repo.FullName(), err)
@@ -360,8 +365,8 @@ func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
360365
}
361366

362367
if err := git.Push(gitRepo.Ctx, basePath, git.PushOptions{
363-
Remote: "origin",
364-
Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, "master"),
368+
Remote: DefaultRemote,
369+
Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, DefaultBranch),
365370
Env: repo_module.PushingEnvironment(doer, repo),
366371
}); err != nil {
367372
if git.IsErrPushOutOfDate(err) || git.IsErrPushRejected(err) {

services/wiki/wiki_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ func TestRepository_AddWikiPage(t *testing.T) {
140140
gitRepo, err := git.OpenRepository(git.DefaultContext, repo.WikiPath())
141141
assert.NoError(t, err)
142142
defer gitRepo.Close()
143-
masterTree, err := gitRepo.GetTree("master")
143+
masterTree, err := gitRepo.GetTree(DefaultBranch)
144144
assert.NoError(t, err)
145145
wikiPath := NameToFilename(wikiName)
146146
entry, err := masterTree.GetTreeEntryByPath(wikiPath)
@@ -184,7 +184,7 @@ func TestRepository_EditWikiPage(t *testing.T) {
184184
// Now need to show that the page has been added:
185185
gitRepo, err := git.OpenRepository(git.DefaultContext, repo.WikiPath())
186186
assert.NoError(t, err)
187-
masterTree, err := gitRepo.GetTree("master")
187+
masterTree, err := gitRepo.GetTree(DefaultBranch)
188188
assert.NoError(t, err)
189189
wikiPath := NameToFilename(newWikiName)
190190
entry, err := masterTree.GetTreeEntryByPath(wikiPath)
@@ -209,7 +209,7 @@ func TestRepository_DeleteWikiPage(t *testing.T) {
209209
gitRepo, err := git.OpenRepository(git.DefaultContext, repo.WikiPath())
210210
assert.NoError(t, err)
211211
defer gitRepo.Close()
212-
masterTree, err := gitRepo.GetTree("master")
212+
masterTree, err := gitRepo.GetTree(DefaultBranch)
213213
assert.NoError(t, err)
214214
wikiPath := NameToFilename("Home")
215215
_, err = masterTree.GetTreeEntryByPath(wikiPath)

0 commit comments

Comments
 (0)