[feat]: [CDS-73030]: added comments

drone · Jul 5, 2023 · aefd6d1 · aefd6d1
1 parent 64a614c
commit aefd6d1
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 0 deletions.
diff --git a/scm/driver/gitea/git.go b/scm/driver/gitea/git.go
@@ -60,6 +60,8 @@ func (s *gitService) ListBranches(ctx context.Context, repo string, opts scm.Lis
 }
 
 func (s *gitService) ListBranchesV2(ctx context.Context, repo string, opts scm.BranchListOptions) ([]*scm.Reference, *scm.Response, error) {
+	// Gitea doesnt provide support listing based on searchTerm
+	// Hence calling the ListBranches
 	return s.ListBranches(ctx, repo, opts.PageListOptions)
 }
 

diff --git a/scm/driver/gitee/git.go b/scm/driver/gitee/git.go
@@ -61,6 +61,8 @@ func (s *gitService) ListBranches(ctx context.Context, repo string, _ scm.ListOp
 }
 
 func (s *gitService) ListBranchesV2(ctx context.Context, repo string, opts scm.BranchListOptions) ([]*scm.Reference, *scm.Response, error) {
+	// Gitee doesnt provide support listing based on searchTerm
+	// Hence calling the ListBranches
 	return s.ListBranches(ctx, repo, opts.PageListOptions)
 }
 

diff --git a/scm/driver/github/git.go b/scm/driver/github/git.go
@@ -54,6 +54,8 @@ func (s *gitService) ListBranches(ctx context.Context, repo string, opts scm.Lis
 }
 
 func (s *gitService) ListBranchesV2(ctx context.Context, repo string, opts scm.BranchListOptions) ([]*scm.Reference, *scm.Response, error) {
+	// Github doesnt provide support listing based on searchTerm
+	// Hence calling the ListBranches
 	return s.ListBranches(ctx, repo, opts.PageListOptions)
 }
 

diff --git a/scm/driver/gogs/git.go b/scm/driver/gogs/git.go
@@ -55,6 +55,8 @@ func (s *gitService) ListBranches(ctx context.Context, repo string, _ scm.ListOp
 }
 
 func (s *gitService) ListBranchesV2(ctx context.Context, repo string, opts scm.BranchListOptions) ([]*scm.Reference, *scm.Response, error) {
+	// Gogs doesnt provide support listing based on searchTerm
+	// Hence calling the ListBranches
 	return s.ListBranches(ctx, repo, opts.PageListOptions)
 }
 

diff --git a/scm/driver/harness/git.go b/scm/driver/harness/git.go
@@ -57,6 +57,8 @@ func (s *gitService) ListBranches(ctx context.Context, repo string, opts scm.Lis
 }
 
 func (s *gitService) ListBranchesV2(ctx context.Context, repo string, opts scm.BranchListOptions) ([]*scm.Reference, *scm.Response, error) {
+	// Harness doesnt provide support listing based on searchTerm
+	// Hence calling the ListBranches
 	return s.ListBranches(ctx, repo, opts.PageListOptions)
 }
 

diff --git a/scm/git.go b/scm/git.go
@@ -72,6 +72,8 @@ type (
 
 		// ListBranches returns a list of git branches.
 		ListBranches(ctx context.Context, repo string, opts ListOptions) ([]*Reference, *Response, error)
+
+		// ListBranchesV2 returns a list of git branches based on the searchTerm passed.
 		ListBranchesV2(ctx context.Context, repo string, opts BranchListOptions) ([]*Reference, *Response, error)
 
 		// ListCommits returns a list of git commits.