support auto_merge_strategy option (#1922)

motatoes · web-flow · commit e7504dc88e99 · 2025-03-26T11:51:10.000+03:00
* support auto_merge_strategy option

* address review errors

* fix build
diff --git a/backend/controllers/projects.go b/backend/controllers/projects.go
@@ -729,20 +729,22 @@ func AutomergePRforBatchIfEnabled(gh utils.GithubClientProvider, batch *models.D
 		log.Printf("Error loading digger config from batch: %v", err)
 		return fmt.Errorf("error loading digger config from batch: %v", err)
 	}
-
-	var automerge bool
-	if diggerConfigYml.AutoMerge != nil {
-		automerge = *diggerConfigYml.AutoMerge
-	} else {
-		automerge = false
+	config, _, err := digger_config.ConvertDiggerYamlToConfig(diggerConfigYml)
+	if err != nil {
+		log.Printf("Error loading digger config from yaml: %v", err)
+		return fmt.Errorf("error loading digger config from yaml: %v", err)
 	}
+
+	automerge := config.AutoMerge
+	automergeStrategy := config.AutoMergeStrategy
+
 	if batch.Status == orchestrator_scheduler.BatchJobSucceeded && batch.BatchType == orchestrator_scheduler.DiggerCommandApply && automerge == true {
 		prService, err := GetPrServiceFromBatch(batch, gh)
 		if err != nil {
 			log.Printf("Error getting github service: %v", err)
 			return fmt.Errorf("error getting github service: %v", err)
 		}
-		err = prService.MergePullRequest(batch.PrNumber)
+		err = prService.MergePullRequest(batch.PrNumber, string(automergeStrategy))
 		if err != nil {
 			log.Printf("Error merging pull request: %v", err)
 			return fmt.Errorf("error merging pull request: %v", err)
diff --git a/cli/pkg/digger/digger.go b/cli/pkg/digger/digger.go
@@ -791,7 +791,7 @@ func SortedCommandsByDependency(project []orchestrator.Job, dependencyGraph *gra
 	return sortedCommands
 }
 
-func MergePullRequest(ciService ci.PullRequestService, prNumber int) {
+func MergePullRequest(ciService ci.PullRequestService, prNumber int, mergeStrategy config.AutomergeStrategy) {
 	time.Sleep(5 * time.Second)
 
 	// CheckAccessPolicy if it was manually merged
@@ -821,7 +821,7 @@ func MergePullRequest(ciService ci.PullRequestService, prNumber int) {
 			log.Fatalf("PR is not mergeable")
 		}
 
-		err = ciService.MergePullRequest(prNumber)
+		err = ciService.MergePullRequest(prNumber, string(mergeStrategy))
 		if err != nil {
 			log.Fatalf("failed to merge PR, %v", err)
 		}
diff --git a/cli/pkg/digger/digger_test.go b/cli/pkg/digger/digger_test.go
@@ -113,7 +113,7 @@ func (m *MockPRManager) GetCombinedPullRequestStatus(prNumber int) (string, erro
 	return "", nil
 }
 
-func (m *MockPRManager) MergePullRequest(prNumber int) error {
+func (m *MockPRManager) MergePullRequest(prNumber int, mergeStrategy string) error {
 	m.Commands = append(m.Commands, RunInfo{"MergePullRequest", strconv.Itoa(prNumber), time.Now()})
 	return nil
 }
diff --git a/cli/pkg/github/github.go b/cli/pkg/github/github.go
@@ -175,18 +175,17 @@ func GitHubCI(lock core_locking.Lock, policyCheckerProvider core_policy.PolicyCh
 
 			StateEnvProvider, CommandEnvProvider := scheduler.GetStateAndCommandProviders(projectConfig)
 
-			stateArn, cmdArn := "",""
-			if(projectConfig.AwsRoleToAssume != nil) {
+			stateArn, cmdArn := "", ""
+			if projectConfig.AwsRoleToAssume != nil {
 				if projectConfig.AwsRoleToAssume.State != "" {
 					stateArn = projectConfig.AwsRoleToAssume.State
 				}
 
 				if projectConfig.AwsRoleToAssume.Command != "" {
-					cmdArn = projectConfig.AwsRoleToAssume.Command					
+					cmdArn = projectConfig.AwsRoleToAssume.Command
 				}
 			}
 
-
 			job := scheduler.Job{
 				ProjectName:        projectConfig.Name,
 				ProjectDir:         projectConfig.Dir,
@@ -204,8 +203,8 @@ func GitHubCI(lock core_locking.Lock, policyCheckerProvider core_policy.PolicyCh
 				EventName:          "drift-detect",
 				StateEnvProvider:   StateEnvProvider,
 				CommandEnvProvider: CommandEnvProvider,
-				StateRoleArn: 	 	stateArn,
-				CommandRoleArn: 	cmdArn,				
+				StateRoleArn:       stateArn,
+				CommandRoleArn:     cmdArn,
 			}
 
 			notification, err := driftNotificationProvider.Get(githubPrService)
@@ -303,7 +302,7 @@ func GitHubCI(lock core_locking.Lock, policyCheckerProvider core_policy.PolicyCh
 		}
 
 		if diggerConfig.AutoMerge && allAppliesSuccessful && atLeastOneApply && coversAllImpactedProjects {
-			digger.MergePullRequest(&githubPrService, prNumber)
+			digger.MergePullRequest(&githubPrService, prNumber, diggerConfig.AutoMergeStrategy)
 			log.Println("PR merged successfully")
 		}
 
diff --git a/docs/ce/howto/auto-merge.mdx b/docs/ce/howto/auto-merge.mdx
@@ -11,4 +11,12 @@ projects:
 - name: production
   dir: prod
 auto_merge: true
+auto_merge_strategy: "squash" # optional, only supported on github
 ```
+
+If you are using github VCS you can also specify
+`auto_merge_strategy` to define the type of strategy. Possible values are:
+
+- squash: for squash merge
+- rebase: for rebase merge
+- merge: for merge commits merge
diff --git a/docs/ce/reference/digger.yml.mdx b/docs/ce/reference/digger.yml.mdx
@@ -98,15 +98,16 @@ workflows:
 
 ### Top-level
 
-| Key                         | Type                                                       | Default | Required | Description                                            | Notes |
-| --------------------------- | ---------------------------------------------------------- | ------- | -------- | ------------------------------------------------------ | ----- |
-| telemetry                   | boolean                                                    | true    | no       | allows collecting anonymised usage and debugging data  |       |
-| auto_merge                  | boolean                                                    | false   | no       | automatically merge pull requests when all checks pass |       |
-| pr_locks                    | boolean                                                    | true    | no       | Enable PR-level locking                                |       |
-| projects                    | array of [Projects](/ce/reference/digger.yml#project)         | \[\]    | no       | list of projects to manage                             |       |
-| generate_projects           | [GenerateProjects](/ce/reference/digger.yml#generateprojects) | {}      | no       | generate projects from a directory structure           |       |
-| workflows                   | map of [Workflows](/ce/reference/digger.yml#workflows)        | {}      | no       | workflows and configurations to run on events          |       |
-| traverse_to_nested_projects | boolean                                                    | false   | no       | enabled traversal of nested directories                |       |
+| Key                         | Type                                                          | Default  | Required | Description                                                                                                                            | Notes                                         |
+|-----------------------------|---------------------------------------------------------------|----------|----------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
+| telemetry                   | boolean                                                       | true     | no       | allows collecting anonymised usage and debugging data                                                                                  |                                               |
+| auto_merge                  | boolean                                                       | false    | no       | automatically merge pull requests when all checks pass                                                                                 |                                               |
+| auto_merge_strategy         | string                                                        | "squash" | no       | The merge strategy to use while automerging, defaults to "squash". Possible values: 'squash', 'merge' (for merge commits) and 'rebase' | currently only github supported for this flag |
+| pr_locks                    | boolean                                                       | true     | no       | Enable PR-level locking                                                                                                                |                                               |
+| projects                    | array of [Projects](/ce/reference/digger.yml#project)         | \[\]     | no       | list of projects to manage                                                                                                             |                                               |
+| generate_projects           | [GenerateProjects](/ce/reference/digger.yml#generateprojects) | {}       | no       | generate projects from a directory structure                                                                                           |                                               |
+| workflows                   | map of [Workflows](/ce/reference/digger.yml#workflows)        | {}       | no       | workflows and configurations to run on events                                                                                          |                                               |
+| traverse_to_nested_projects | boolean                                                       | false    | no       | enabled traversal of nested directories                                                                                                |                                               |
 
 ### Project
 
diff --git a/libs/ci/azure/azure.go b/libs/ci/azure/azure.go
@@ -273,7 +273,7 @@ func (a *AzureReposService) GetCombinedPullRequestStatus(prNumber int) (string,
 	return "pending", nil
 }
 
-func (a *AzureReposService) MergePullRequest(prNumber int) error {
+func (a *AzureReposService) MergePullRequest(prNumber int, mergeStrategy string) error {
 	pullRequest, err := a.Client.GetPullRequestById(context.Background(), git.GetPullRequestByIdArgs{
 		Project:       &a.ProjectName,
 		PullRequestId: &prNumber,
diff --git a/libs/ci/bitbucket/bitbucket.go b/libs/ci/bitbucket/bitbucket.go
@@ -381,7 +381,7 @@ func (b BitbucketAPI) GetCombinedPullRequestStatus(prNumber int) (string, error)
 
 }
 
-func (b BitbucketAPI) MergePullRequest(prNumber int) error {
+func (b BitbucketAPI) MergePullRequest(prNumber int, mergeStrategy string) error {
 	url := fmt.Sprintf("%s/repositories/%s/%s/pullrequests/%d/merge", bitbucketBaseURL, b.RepoWorkspace, b.RepoName, prNumber)
 
 	resp, err := b.sendRequest("POST", url, nil)
diff --git a/libs/ci/ci.go b/libs/ci/ci.go
@@ -15,7 +15,7 @@ type PullRequestService interface {
 	// SetStatus set status of specified pull/merge request, status could be: "pending", "failure", "success"
 	SetStatus(prNumber int, status string, statusContext string) error
 	GetCombinedPullRequestStatus(prNumber int) (string, error)
-	MergePullRequest(prNumber int) error
+	MergePullRequest(prNumber int, mergeStrategy string) error
 	// IsMergeable is still open and ready to be merged
 	IsMergeable(prNumber int) (bool, error)
 	// IsMerged merged and closed
diff --git a/libs/ci/github/github.go b/libs/ci/github/github.go
@@ -284,7 +284,7 @@ func (svc GithubService) GetCombinedPullRequestStatus(prNumber int) (string, err
 	return *statuses.State, nil
 }
 
-func (svc GithubService) MergePullRequest(prNumber int) error {
+func (svc GithubService) MergePullRequest(prNumber int, mergeStrategy string) error {
 	isPullRequest, err := svc.IsPullRequest(prNumber)
 	if err != nil {
 		log.Printf("error checking if PR is issue: %v", err)
@@ -314,7 +314,7 @@ func (svc GithubService) MergePullRequest(prNumber int) error {
 	}
 
 	_, _, err = svc.Client.PullRequests.Merge(context.Background(), svc.Owner, svc.RepoName, prNumber, "auto-merge", &github.PullRequestOptions{
-		MergeMethod: "squash",
+		MergeMethod: mergeStrategy,
 		SHA:         pr.Head.GetSHA(),
 	})
 	return err
diff --git a/libs/ci/github/mocks.go b/libs/ci/github/mocks.go
@@ -59,7 +59,7 @@ func (t MockCiService) GetCombinedPullRequestStatus(prNumber int) (string, error
 	return "", nil
 }
 
-func (t MockCiService) MergePullRequest(prNumber int) error {
+func (t MockCiService) MergePullRequest(prNumber int, mergeStrategy string) error {
 	return nil
 }
 
diff --git a/libs/ci/gitlab/gitlab.go b/libs/ci/gitlab/gitlab.go
@@ -215,7 +215,7 @@ func (gitlabService GitLabService) GetCombinedPullRequestStatus(mergeRequestID i
 	return "success", nil
 }
 
-func (gitlabService GitLabService) MergePullRequest(mergeRequestID int) error {
+func (gitlabService GitLabService) MergePullRequest(mergeRequestID int, mergeStrategy string) error {
 	projectId := *gitlabService.Context.ProjectId
 	mergeRequestIID := *gitlabService.Context.MergeRequestIId
 	mergeWhenPipelineSucceeds := true
diff --git a/libs/ci/mocks.go b/libs/ci/mocks.go
@@ -43,7 +43,7 @@ func (t MockPullRequestManager) GetApprovals(prNumber int) ([]string, error) {
 	return t.Approvals, nil
 }
 
-func (t MockPullRequestManager) MergePullRequest(prNumber int) error {
+func (t MockPullRequestManager) MergePullRequest(prNumber int, mergeStrategy string) error {
 	return nil
 }
 
diff --git a/libs/comment_utils/reporting/reporting_test.go b/libs/comment_utils/reporting/reporting_test.go
@@ -59,7 +59,7 @@ func (t MockCiService) GetCombinedPullRequestStatus(prNumber int) (string, error
 	return "", nil
 }
 
-func (t MockCiService) MergePullRequest(prNumber int) error {
+func (t MockCiService) MergePullRequest(prNumber int, mergeStrategy string) error {
 	return nil
 }
 
diff --git a/libs/digger_config/config.go b/libs/digger_config/config.go
@@ -3,6 +3,12 @@ package digger_config
 const CommentRenderModeBasic = "basic"
 const CommentRenderModeGroupByModule = "group_by_module"
 
+type AutomergeStrategy string
+
+const AutomergeStrategySquash AutomergeStrategy = "squash"
+const AutomergeStrategyMerge AutomergeStrategy = "merge"
+const AutomergeStrategyRebase AutomergeStrategy = "rebase"
+
 type DiggerConfig struct {
 	ApplyAfterMerge            bool
 	AllowDraftPRs              bool
@@ -11,6 +17,7 @@ type DiggerConfig struct {
 	PrLocks                    bool
 	Projects                   []Project
 	AutoMerge                  bool
+	AutoMergeStrategy          AutomergeStrategy
 	Telemetry                  bool
 	Workflows                  map[string]Workflow
 	MentionDriftedProjectsInPR bool
diff --git a/libs/digger_config/converters.go b/libs/digger_config/converters.go
@@ -209,6 +209,16 @@ func ConvertDiggerYamlToConfig(diggerYaml *DiggerConfigYaml) (*DiggerConfig, gra
 		diggerConfig.AutoMerge = false
 	}
 
+	if diggerYaml.AutoMergeStrategy != nil {
+		err := ValidateAutomergeStrategy(*diggerYaml.AutoMergeStrategy)
+		if err != nil {
+			return nil, nil, err
+		}
+		diggerConfig.AutoMergeStrategy = AutomergeStrategy(*diggerYaml.AutoMergeStrategy)
+	} else {
+		diggerConfig.AutoMergeStrategy = AutomergeStrategySquash
+	}
+
 	if diggerYaml.ApplyAfterMerge != nil {
 		diggerConfig.ApplyAfterMerge = *diggerYaml.ApplyAfterMerge
 	} else {
diff --git a/libs/digger_config/validators.go b/libs/digger_config/validators.go
@@ -0,0 +1,12 @@
+package digger_config
+
+import "fmt"
+
+func ValidateAutomergeStrategy(strategy string) error {
+	switch strategy {
+	case string(AutomergeStrategySquash), string(AutomergeStrategyMerge), string(AutomergeStrategyRebase):
+		return nil
+	default:
+		return fmt.Errorf("invalid merge strategy: %v, valid values are: %v, %v, %v", strategy, AutomergeStrategySquash, AutomergeStrategyMerge, AutomergeStrategyRebase)
+	}
+}
diff --git a/libs/digger_config/yaml.go b/libs/digger_config/yaml.go
@@ -13,6 +13,7 @@ type DiggerConfigYaml struct {
 	PrLocks                    *bool                        `yaml:"pr_locks"`
 	Projects                   []*ProjectYaml               `yaml:"projects"`
 	AutoMerge                  *bool                        `yaml:"auto_merge"`
+	AutoMergeStrategy          *string                      `yaml:"auto_merge_strategy"`
 	CommentRenderMode          *string                      `yaml:"comment_render_mode"`
 	Workflows                  map[string]*WorkflowYaml     `yaml:"workflows"`
 	Telemetry                  *bool                        `yaml:"telemetry,omitempty"`
diff --git a/libs/orchestrator/mock.go b/libs/orchestrator/mock.go
@@ -47,7 +47,7 @@ func (mockGithubPullrequestManager *MockGithubPullrequestManager) GetCombinedPul
 	return "", nil
 }
 
-func (mockGithubPullrequestManager *MockGithubPullrequestManager) MergePullRequest(prNumber int) error {
+func (mockGithubPullrequestManager *MockGithubPullrequestManager) MergePullRequest(prNumber int, mergeStrategy string) error {
 	mockGithubPullrequestManager.commands = append(mockGithubPullrequestManager.commands, "MergePullRequest")
 	return nil
 }

Original file line number	Diff line number	Diff line change
`@@ -791,7 +791,7 @@ func SortedCommandsByDependency(project []orchestrator.Job, dependencyGraph *gra`
`791`	`791`	`return sortedCommands`
`792`	`792`	`}`
`793`	`793`
`794`		`-func MergePullRequest(ciService ci.PullRequestService, prNumber int) {`
	`794`	`+func MergePullRequest(ciService ci.PullRequestService, prNumber int, mergeStrategy config.AutomergeStrategy) {`
`795`	`795`	`time.Sleep(5 * time.Second)`
`796`	`796`
`797`	`797`	`// CheckAccessPolicy if it was manually merged`
`@@ -821,7 +821,7 @@ func MergePullRequest(ciService ci.PullRequestService, prNumber int) {`
`821`	`821`	`log.Fatalf("PR is not mergeable")`
`822`	`822`	`}`
`823`	`823`
`824`		`- err = ciService.MergePullRequest(prNumber)`
	`824`	`+ err = ciService.MergePullRequest(prNumber, string(mergeStrategy))`
`825`	`825`	`if err != nil {`
`826`	`826`	`log.Fatalf("failed to merge PR, %v", err)`
`827`	`827`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ func (m *MockPRManager) GetCombinedPullRequestStatus(prNumber int) (string, erro`
`113`	`113`	`return "", nil`
`114`	`114`	`}`
`115`	`115`
`116`		`-func (m *MockPRManager) MergePullRequest(prNumber int) error {`
	`116`	`+func (m *MockPRManager) MergePullRequest(prNumber int, mergeStrategy string) error {`
`117`	`117`	`m.Commands = append(m.Commands, RunInfo{"MergePullRequest", strconv.Itoa(prNumber), time.Now()})`
`118`	`118`	`return nil`
`119`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,18 +175,17 @@ func GitHubCI(lock core_locking.Lock, policyCheckerProvider core_policy.PolicyCh`
`175`	`175`
`176`	`176`	`StateEnvProvider, CommandEnvProvider := scheduler.GetStateAndCommandProviders(projectConfig)`
`177`	`177`
`178`		`- stateArn, cmdArn := "",""`
`179`		`- if(projectConfig.AwsRoleToAssume != nil) {`
	`178`	`+ stateArn, cmdArn := "", ""`
	`179`	`+ if projectConfig.AwsRoleToAssume != nil {`
`180`	`180`	`if projectConfig.AwsRoleToAssume.State != "" {`
`181`	`181`	`stateArn = projectConfig.AwsRoleToAssume.State`
`182`	`182`	`}`
`183`	`183`
`184`	`184`	`if projectConfig.AwsRoleToAssume.Command != "" {`
`185`		`- cmdArn = projectConfig.AwsRoleToAssume.Command`
	`185`	`+ cmdArn = projectConfig.AwsRoleToAssume.Command`
`186`	`186`	`}`
`187`	`187`	`}`
`188`	`188`
`189`		`-`
`190`	`189`	`job := scheduler.Job{`
`191`	`190`	`ProjectName: projectConfig.Name,`
`192`	`191`	`ProjectDir: projectConfig.Dir,`
`@@ -204,8 +203,8 @@ func GitHubCI(lock core_locking.Lock, policyCheckerProvider core_policy.PolicyCh`
`204`	`203`	`EventName: "drift-detect",`
`205`	`204`	`StateEnvProvider: StateEnvProvider,`
`206`	`205`	`CommandEnvProvider: CommandEnvProvider,`
`207`		`- StateRoleArn: stateArn,`
`208`		`- CommandRoleArn: cmdArn,`
	`206`	`+ StateRoleArn: stateArn,`
	`207`	`+ CommandRoleArn: cmdArn,`
`209`	`208`	`}`
`210`	`209`
`211`	`210`	`notification, err := driftNotificationProvider.Get(githubPrService)`
`@@ -303,7 +302,7 @@ func GitHubCI(lock core_locking.Lock, policyCheckerProvider core_policy.PolicyCh`
`303`	`302`	`}`
`304`	`303`
`305`	`304`	`if diggerConfig.AutoMerge && allAppliesSuccessful && atLeastOneApply && coversAllImpactedProjects {`
`306`		`- digger.MergePullRequest(&githubPrService, prNumber)`
	`305`	`+ digger.MergePullRequest(&githubPrService, prNumber, diggerConfig.AutoMergeStrategy)`
`307`	`306`	`log.Println("PR merged successfully")`
`308`	`307`	`}`
`309`	`308`
Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,7 @@ func (a *AzureReposService) GetCombinedPullRequestStatus(prNumber int) (string,`
`273`	`273`	`return "pending", nil`
`274`	`274`	`}`
`275`	`275`
`276`		`-func (a *AzureReposService) MergePullRequest(prNumber int) error {`
	`276`	`+func (a *AzureReposService) MergePullRequest(prNumber int, mergeStrategy string) error {`
`277`	`277`	`pullRequest, err := a.Client.GetPullRequestById(context.Background(), git.GetPullRequestByIdArgs{`
`278`	`278`	`Project: &a.ProjectName,`
`279`	`279`	`PullRequestId: &prNumber,`
Original file line number	Diff line number	Diff line change
`@@ -381,7 +381,7 @@ func (b BitbucketAPI) GetCombinedPullRequestStatus(prNumber int) (string, error)`
`381`	`381`
`382`	`382`	`}`
`383`	`383`
`384`		`-func (b BitbucketAPI) MergePullRequest(prNumber int) error {`
	`384`	`+func (b BitbucketAPI) MergePullRequest(prNumber int, mergeStrategy string) error {`
`385`	`385`	`url := fmt.Sprintf("%s/repositories/%s/%s/pullrequests/%d/merge", bitbucketBaseURL, b.RepoWorkspace, b.RepoName, prNumber)`
`386`	`386`
`387`	`387`	`resp, err := b.sendRequest("POST", url, nil)`