fix

Author: wxiaoguang

modules/git/submodule.go

@@ -9,15 +9,14 @@ import (
 	"code.gitea.io/gitea/modules/log"
 )
 
-// SubModuleCommit submodule name and commit from a repository
-type SubModuleCommit struct {
+type TemplateSubmoduleCommit struct {
 	Path   string
 	Commit string
 }
 
-// GetSubmoduleCommits returns a list of submodules paths and their commits from a repository
+// GetTemplateSubmoduleCommits returns a list of submodules paths and their commits from a repository
 // This function is only for generating new repos based on existing template, the template couldn't be too large.
-func GetSubmoduleCommits(ctx context.Context, repoPath string) (submoduleCommits []SubModuleCommit, _ error) {
+func GetTemplateSubmoduleCommits(ctx context.Context, repoPath string) (submoduleCommits []TemplateSubmoduleCommit, _ error) {
 	stdoutReader, stdoutWriter, err := os.Pipe()
 	if err != nil {
 		return nil, err
@@ -37,21 +36,22 @@ func GetSubmoduleCommits(ctx context.Context, repoPath string) (submoduleCommits
 					return err
 				}
 				if entry.IsSubModule() {
-					submoduleCommits = append(submoduleCommits, SubModuleCommit{Path: entry.Name(), Commit: entry.ID.String()})
+					submoduleCommits = append(submoduleCommits, TemplateSubmoduleCommit{Path: entry.Name(), Commit: entry.ID.String()})
 				}
 			}
 			return scanner.Err()
 		},
 	}
 	err = NewCommand(ctx, "ls-tree", "-r", "--", "HEAD").Run(opts)
 	if err != nil {
-		return nil, fmt.Errorf("GetSubmoduleCommits: error running git ls-tree: %v", err)
+		return nil, fmt.Errorf("GetTemplateSubmoduleCommits: error running git ls-tree: %v", err)
 	}
 	return submoduleCommits, nil
 }
 
-// AddSubmoduleIndexes Adds the given submodules to the git index. Requires the .gitmodules file to be already present.
-func AddSubmoduleIndexes(ctx context.Context, repoPath string, submodules []SubModuleCommit) error {
+// AddTemplateSubmoduleIndexes Adds the given submodules to the git index.
+// It is only for generating new repos based on existing template, requires the .gitmodules file to be already present in the work dir.
+func AddTemplateSubmoduleIndexes(ctx context.Context, repoPath string, submodules []TemplateSubmoduleCommit) error {
 	for _, submodule := range submodules {
 		cmd := NewCommand(ctx, "update-index", "--add", "--cacheinfo", "160000").AddDynamicArguments(submodule.Commit, submodule.Path)
 		if stdout, _, err := cmd.RunStdString(&RunOpts{Dir: repoPath}); err != nil {

modules/git/submodule_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestRepository_GetSubmoduleCommits(t *testing.T) {
 	testRepoPath := filepath.Join(testReposDir, "repo4_submodules")
-	submodules, err := GetSubmoduleCommits(DefaultContext, testRepoPath)
+	submodules, err := GetTemplateSubmoduleCommits(DefaultContext, testRepoPath)
 	require.NoError(t, err)
 
 	assert.EqualValues(t, len(submodules), 2)

services/repository/generate.go

@@ -210,9 +210,9 @@ func generateRepoCommit(ctx context.Context, repo, templateRepo, generateRepo *r
 	}
 
 	// Get active submodules from the template
-	submodules, err := git.GetSubmoduleCommits(ctx, tmpDir)
+	submodules, err := git.GetTemplateSubmoduleCommits(ctx, tmpDir)
 	if err != nil {
-		return fmt.Errorf("GetSubmoduleCommits: %w", err)
+		return fmt.Errorf("GetTemplateSubmoduleCommits: %w", err)
 	}
 
 	if err = util.RemoveAll(filepath.Join(tmpDir, ".git")); err != nil {
@@ -242,7 +242,7 @@ func generateRepoCommit(ctx context.Context, repo, templateRepo, generateRepo *r
 		return fmt.Errorf("git remote add: %w", err)
 	}
 
-	if err = git.AddSubmoduleIndexes(ctx, tmpDir, submodules); err != nil {
+	if err = git.AddTemplateSubmoduleIndexes(ctx, tmpDir, submodules); err != nil {
 		return fmt.Errorf("failed to add submodules: %v", err)
 	}
 

templates/repo/view_list.tmpl

@@ -19,9 +19,9 @@
 					{{svg "octicon-file-submodule"}}
 					{{$refURL := $subModuleFile.RefURL AppUrl $.Repository.FullName $.SSHDomain}} {{/* FIXME: the usage of AppUrl seems incorrect, it would be fixed in the future, use AppSubUrl instead */}}
 					{{if $refURL}}
-						<a class="muted" href="{{$refURL}}">{{$entry.Name}}</a><span class="at">@</span><a href="{{$refURL}}/commit/{{PathEscape $subModuleFile.RefID}}">{{ShortSha $subModuleFile.RefID}}</a>
+						<a class="muted" href="{{$refURL}}">{{$entry.Name}}</a> <span class="at">@</span> <a href="{{$refURL}}/commit/{{PathEscape $subModuleFile.RefID}}">{{ShortSha $subModuleFile.RefID}}</a>
 					{{else}}
-						{{$entry.Name}}<span class="at">@</span>{{ShortSha $subModuleFile.RefID}}
+						{{$entry.Name}} <span class="at">@</span> {{ShortSha $subModuleFile.RefID}}
 					{{end}}
 				{{else}}
 					{{if $entry.IsDir}}