add support for target branch of projects (#2125)

motatoes · web-flow · commit 6e6c1b876258 · 2025-09-09T18:49:40.000+01:00
* add support for target branch of projects
diff --git a/backend/controllers/github_comment.go b/backend/controllers/github_comment.go
@@ -210,7 +210,7 @@ func handleIssueCommentEvent(gh utils.GithubClientProvider, payload *github.Issu
 		"command", *diggerCommand,
 	)
 
-	prBranchName, _, err := ghService.GetBranchName(issueNumber)
+	prBranchName, _, targetBranch, _, err := ghService.GetBranchName(issueNumber)
 	if err != nil {
 		slog.Error("Error getting branch name",
 			"issueNumber", issueNumber,
@@ -247,6 +247,8 @@ func handleIssueCommentEvent(gh utils.GithubClientProvider, payload *github.Issu
 		return fmt.Errorf("error filtering out projects from comment")
 	}
 
+	impactedProjectsForComment = generic.FilterTargetBranchForImpactedProjects(impactedProjectsForComment, defaultBranch, targetBranch)
+
 	slog.Info("Issue comment event processed successfully",
 		"issueNumber", issueNumber,
 		"impactedProjectCount", len(impactedProjectsForComment),
diff --git a/backend/controllers/github_helpers.go b/backend/controllers/github_helpers.go
@@ -616,7 +616,7 @@ func getDiggerConfigForPR(gh utils.GithubClientProvider, orgId uint, prLabels []
 	}
 
 	var prBranch string
-	prBranch, prCommitSha, err := ghService.GetBranchName(prNumber)
+	prBranch, prCommitSha, _, _, err := ghService.GetBranchName(prNumber)
 	if err != nil {
 		slog.Error("Error getting branch name for PR",
 			"prNumber", prNumber,
diff --git a/backend/controllers/github_pull_request.go b/backend/controllers/github_pull_request.go
@@ -95,7 +95,7 @@ func handlePullRequestEvent(gh utils.GithubClientProvider, payload *github.PullR
 		// we sleep for 1 second to give github time to delete the branch
 		time.Sleep(1 * time.Second)
 
-		branchName, _, err := ghService.GetBranchName(prNumber)
+		branchName, _, _, _, err := ghService.GetBranchName(prNumber)
 		if err != nil {
 			slog.Error("Could not retrieve PR details", "prNumber", prNumber, "error", err)
 			utils.InitCommentReporter(ghService, prNumber, fmt.Sprintf(":x: Could not retrieve PR details, error: %v", err))
diff --git a/cli/pkg/digger/digger_test.go b/cli/pkg/digger/digger_test.go
@@ -164,9 +164,9 @@ func (m *MockPRManager) CreateCommentReaction(id string, reaction string) error
 	return nil
 }
 
-func (m *MockPRManager) GetBranchName(prNumber int) (string, string, error) {
+func (m *MockPRManager) GetBranchName(prNumber int) (string, string, string, string, error) {
 	m.Commands = append(m.Commands, RunInfo{"GetBranchName", strconv.Itoa(prNumber), time.Now()})
-	return "", "", nil
+	return "", "", "", "", nil
 }
 
 func (m *MockPRManager) SetOutput(prNumber int, key string, value string) error {
diff --git a/cli/pkg/github/github.go b/cli/pkg/github/github.go
@@ -300,7 +300,7 @@ func GitHubCI(lock core_locking.Lock, policyCheckerProvider core_policy.PolicyCh
 		if prEvent, ok := ghEvent.(github.PullRequestEvent); ok {
 			jobs, coversAllImpactedProjects, err = dg_github.ConvertGithubPullRequestEventToJobs(&prEvent, impactedProjects, requestedProject, *diggerConfig, true)
 		} else if commentEvent, ok := ghEvent.(github.IssueCommentEvent); ok {
-			prBranchName, _, err := githubPrService.GetBranchName(*commentEvent.Issue.Number)
+			prBranchName, _, _, _, err := githubPrService.GetBranchName(*commentEvent.Issue.Number)
 
 			if err != nil {
 				usage.ReportErrorAndExit(githubActor, fmt.Sprintf("Error while retrieving default branch from Issue: %v", err), 6)
diff --git a/docs/ce/reference/digger.yml.mdx b/docs/ce/reference/digger.yml.mdx
@@ -26,13 +26,15 @@ pr_locks: true
 projects:
   - name: prod
     dir: prod
+    branch: main
     workspace: default
     terragrunt: false
     workflow: prod
     include_patterns: ["../modules/**"]
     exclude_patterns: []
   - name: staging
     dir: staging
+    branch: main
     workflow: staging
     include_patterns: ["../modules/**"]
     exclude_patterns: []    
@@ -115,6 +117,7 @@ workflows:
 | Key                      | Type                                                 | Default | Required | Description                                                        | Notes                                                                                                     |
 | ------------------------ | ---------------------------------------------------- | ------- | -------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
 | name                     | string                                               |        | yes      | name of the project                                                | must be unique                                                                                             |
+| branch                   | string                                               |        | yes      | the target branch to match this project on                         | This field is optional and defaults to the repository's default branch when not set                        |
 | dir                      | string                                               |        | yes      | directory containing the project                                   |                                                                                                            |
 | workspace                | string                                               | default | no       | terraform workspace to use                                         |                                                                                                           |
 | opentofu                 | boolean                                              | false   | no       | whether to use opentofu                                            |                                                                                                           |
diff --git a/ee/backend/controllers/bitbucket.go b/ee/backend/controllers/bitbucket.go
@@ -208,7 +208,7 @@ func handleIssueCommentEventBB(bitbucketProvider utils.BitbucketProvider, payloa
 		return fmt.Errorf("unknown digger command in comment %v", err)
 	}
 
-	prBranchName, _, err := bbService.GetBranchName(issueNumber)
+	prBranchName, _, _, _, err := bbService.GetBranchName(issueNumber)
 	if err != nil {
 		log.Printf("GetBranchName error: %v", err)
 		utils.InitCommentReporter(bbService, issueNumber, fmt.Sprintf(":x: GetBranchName error: %v", err))
diff --git a/ee/backend/controllers/gitlab.go b/ee/backend/controllers/gitlab.go
@@ -142,7 +142,7 @@ func handlePullRequestEvent(gitlabProvider utils.GitlabProvider, payload *gitlab
 	// here we check if pr was merged and automatic deletion is enabled, to avoid errors when
 	// pr is merged and the branch does not exist we handle that gracefully
 	if action == "merge" {
-		sourceBranch, _, err := glService.GetBranchName(prNumber)
+		sourceBranch, _, _, _, err := glService.GetBranchName(prNumber)
 		if err != nil {
 			utils.InitCommentReporter(glService, prNumber, fmt.Sprintf(":x: Could not retrieve PR details, error: %v", err))
 			log.Printf("Could not retrieve PR details error: %v", err)
@@ -393,7 +393,7 @@ func handleIssueCommentEvent(gitlabProvider utils.GitlabProvider, payload *gitla
 		return fmt.Errorf("unknown digger command in comment %v", err)
 	}
 
-	prBranchName, _, err := glService.GetBranchName(issueNumber)
+	prBranchName, _, _, _, err := glService.GetBranchName(issueNumber)
 	if err != nil {
 		log.Printf("GetBranchName error: %v", err)
 		utils.InitCommentReporter(glService, issueNumber, fmt.Sprintf(":x: GetBranchName error: %v", err))
diff --git a/libs/ci/azure/azure.go b/libs/ci/azure/azure.go
@@ -356,9 +356,9 @@ func (a *AzureReposService) CreateCommentReaction(id string, reaction string) er
 	return nil
 }
 
-func (a *AzureReposService) GetBranchName(prNumber int) (string, string, error) {
+func (a *AzureReposService) GetBranchName(prNumber int) (string, string, string, string, error) {
 	//TODO implement me
-	return "", "", nil
+	return "", "", "", "", nil
 }
 
 func (svc *AzureReposService) SetOutput(prNumber int, key string, value string) error {
diff --git a/libs/ci/bitbucket/bitbucket.go b/libs/ci/bitbucket/bitbucket.go
@@ -477,17 +477,17 @@ func (b BitbucketAPI) IsClosed(prNumber int) (bool, error) {
 	return pullRequest.State != "OPEN", nil
 }
 
-func (b BitbucketAPI) GetBranchName(prNumber int) (string, string, error) {
+func (b BitbucketAPI) GetBranchName(prNumber int) (string, string, string, string, error) {
 	url := fmt.Sprintf("%s/repositories/%s/%s/pullrequests/%d", bitbucketBaseURL, b.RepoWorkspace, b.RepoName, prNumber)
 
 	resp, err := b.sendRequest("GET", url, nil)
 	if err != nil {
-		return "", "", err
+		return "", "", "", "", err
 	}
 	defer resp.Body.Close()
 
 	if resp.StatusCode != http.StatusOK {
-		return "", "", fmt.Errorf("failed to get pull request. Status code: %d", resp.StatusCode)
+		return "", "", "", "", fmt.Errorf("failed to get pull request. Status code: %d", resp.StatusCode)
 	}
 
 	var pullRequest struct {
@@ -500,10 +500,10 @@ func (b BitbucketAPI) GetBranchName(prNumber int) (string, string, error) {
 
 	err = json.NewDecoder(resp.Body).Decode(&pullRequest)
 	if err != nil {
-		return "", "", err
+		return "", "", "", "", err
 	}
 
-	return pullRequest.Source.Branch.Name, "", nil
+	return pullRequest.Source.Branch.Name, "", "", "", nil
 }
 
 func (svc BitbucketAPI) SetOutput(prNumber int, key string, value string) error {
diff --git a/libs/ci/ci.go b/libs/ci/ci.go
@@ -23,7 +23,7 @@ type PullRequestService interface {
 	IsMerged(prNumber int) (bool, error)
 	// IsClosed closed without merging
 	IsClosed(prNumber int) (bool, error)
-	GetBranchName(prNumber int) (string, string, error)
+	GetBranchName(prNumber int) (string, string, string, string, error)
 	SetOutput(prNumber int, key string, value string) error
 }
 
diff --git a/libs/ci/generic/comment_filter.go b/libs/ci/generic/comment_filter.go
@@ -6,6 +6,21 @@ import (
 	"github.com/samber/lo"
 )
 
+// FilterTargetBranchForImpactedProjects filters out all projects that do not meet the target branch requirement
+func FilterTargetBranchForImpactedProjects(impactedProjects []digger_config.Project, defaultBranch string, targetBranch string) []digger_config.Project {
+	// filter out projects that don't meet targetBranch
+	impactedProjects = lo.Filter(impactedProjects, func(item digger_config.Project, index int) bool {
+		var projectTargetBranch string
+		if item.Branch == digger_config.DefaultBranchName {
+			projectTargetBranch = defaultBranch
+		} else {
+			projectTargetBranch = item.Branch
+		}
+		return projectTargetBranch == targetBranch
+	})
+	return impactedProjects
+}
+
 func FilterOutProjectsFromComment(impactedProjects []digger_config.Project, comment string) ([]digger_config.Project, error) {
 	var filteredProjects []digger_config.Project
 	commentParts, valid, err := ParseDiggerCommentFlags(comment)
diff --git a/libs/ci/github/github.go b/libs/ci/github/github.go
@@ -442,14 +442,16 @@ func (svc GithubService) SetOutput(prNumber int, key string, value string) error
 	return nil
 }
 
-func (svc GithubService) GetBranchName(prNumber int) (string, string, error) {
+func (svc GithubService) GetBranchName(prNumber int) (string, string, string, string, error) {
 	pr, _, err := svc.Client.PullRequests.Get(context.Background(), svc.Owner, svc.RepoName, prNumber)
 	if err != nil {
 		slog.Error("error getting pull request", "error", err, "prNumber", prNumber)
-		return "", "", fmt.Errorf("error getting pull request: %v", err)
+		return "", "", "", "", fmt.Errorf("error getting pull request: %v", err)
 	}
 
-	return pr.Head.GetRef(), pr.Head.GetSHA(), nil
+	targetBranch := pr.Base.GetRef()
+	targetSha := pr.Base.GetSHA()
+	return pr.Head.GetRef(), pr.Head.GetSHA(), targetBranch, targetSha, nil
 }
 
 func (svc GithubService) GetHeadCommitFromBranch(branch string) (string, string, error) {
@@ -737,6 +739,8 @@ func ProcessGitHubPullRequestEvent(payload *github.PullRequestEvent, diggerConfi
 	var impactedProjects []digger_config.Project
 	var prNumber int
 	prNumber = *payload.PullRequest.Number
+	defaultBranch := *payload.Repo.DefaultBranch
+	targetBranch := payload.PullRequest.Base.GetRef()
 
 	slog.Info("processing GitHub pull request event",
 		"prNumber", prNumber,
@@ -754,6 +758,8 @@ func ProcessGitHubPullRequestEvent(payload *github.PullRequestEvent, diggerConfi
 		"count", len(impactedProjects),
 		"prNumber", prNumber)
 
+	impactedProjects = generic.FilterTargetBranchForImpactedProjects(impactedProjects, defaultBranch, targetBranch)
+
 	if diggerConfig.DependencyConfiguration.Mode == digger_config.DependencyConfigurationHard {
 		slog.Debug("using hard dependency mode, finding all dependent projects", "prNumber", prNumber)
 		originalCount := len(impactedProjects)
diff --git a/libs/ci/github/mocks.go b/libs/ci/github/mocks.go
@@ -108,8 +108,8 @@ func (t MockCiService) CreateCommentReaction(id string, reaction string) error {
 	return nil
 }
 
-func (t MockCiService) GetBranchName(prNumber int) (string, string, error) {
-	return "", "", nil
+func (t MockCiService) GetBranchName(prNumber int) (string, string, string, string, error) {
+	return "", "", "", "", nil
 }
 
 func (svc MockCiService) SetOutput(prNumber int, key string, value string) error {
diff --git a/libs/ci/gitlab/gitlab.go b/libs/ci/gitlab/gitlab.go
@@ -349,7 +349,7 @@ func (gitlabService GitLabService) GetApprovals(prNumber int) ([]string, error)
 	return approvals, nil
 }
 
-func (gitlabService GitLabService) GetBranchName(prNumber int) (string, string, error) {
+func (gitlabService GitLabService) GetBranchName(prNumber int) (string, string, string, string, error) {
 	//TODO implement me
 	projectId := *gitlabService.Context.ProjectId
 	slog.Debug("getting branch name", "prNumber", prNumber, "projectId", projectId)
@@ -358,9 +358,9 @@ func (gitlabService GitLabService) GetBranchName(prNumber int) (string, string,
 	pr, _, err := gitlabService.Client.MergeRequests.GetMergeRequest(projectId, prNumber, &options)
 	if err != nil {
 		slog.Error("error getting branch name for PR", "error", err, "prNumber", prNumber)
-		return "", "", err
+		return "", "", "", "", err
 	}
-	return pr.SourceBranch, pr.SHA, nil
+	return pr.SourceBranch, pr.SHA, "", "", nil
 }
 
 func (gitlabService GitLabService) CheckBranchExists(branchName string) (bool, error) {
diff --git a/libs/ci/mocks.go b/libs/ci/mocks.go
@@ -79,8 +79,8 @@ func (t MockPullRequestManager) CreateCommentReaction(id string, reaction string
 	return nil
 }
 
-func (t MockPullRequestManager) GetBranchName(prNumber int) (string, string, error) {
-	return "", "", nil
+func (t MockPullRequestManager) GetBranchName(prNumber int) (string, string, string, string, error) {
+	return "", "", "", "", nil
 }
 
 func (t MockPullRequestManager) SetOutput(prNumber int, key string, value string) error {
diff --git a/libs/comment_utils/reporting/reporting_test.go b/libs/comment_utils/reporting/reporting_test.go
@@ -108,8 +108,8 @@ func (svc MockCiService) CreateCommentReaction(id string, reaction string) error
 	return nil
 }
 
-func (svc MockCiService) GetBranchName(prNumber int) (string, string, error) {
-	return "", "", nil
+func (svc MockCiService) GetBranchName(prNumber int) (string, string, string, string, error) {
+	return "", "", "", "", nil
 }
 
 func (svc MockCiService) SetOutput(prNumber int, key string, value string) error {
diff --git a/libs/digger_config/config.go b/libs/digger_config/config.go
@@ -9,6 +9,8 @@ const AutomergeStrategySquash AutomergeStrategy = "squash"
 const AutomergeStrategyMerge AutomergeStrategy = "merge"
 const AutomergeStrategyRebase AutomergeStrategy = "rebase"
 
+const DefaultBranchName = "__default__"
+
 type DiggerConfig struct {
 	ApplyAfterMerge            bool
 	AllowDraftPRs              bool
@@ -46,6 +48,7 @@ type AssumeRoleForProject struct {
 type Project struct {
 	BlockName            string // the block name if this is a generated project
 	Name                 string
+	Branch               string
 	Alias                string
 	Dir                  string
 	Workspace            string
diff --git a/libs/digger_config/converters.go b/libs/digger_config/converters.go
@@ -29,6 +29,11 @@ func copyProjects(projects []*ProjectYaml) []Project {
 			layer = *p.Layer
 		}
 
+		branch := DefaultBranchName
+		if p.Branch != nil {
+			branch = *p.Branch
+		}
+
 		var roleToAssume *AssumeRoleForProject = nil
 		if p.AwsRoleToAssume != nil {
 
@@ -76,6 +81,7 @@ func copyProjects(projects []*ProjectYaml) []Project {
 		item := Project{
 			p.BlockName,
 			p.Name,
+			branch,
 			p.Alias,
 			p.Dir,
 			workspace,
diff --git a/libs/digger_config/yaml.go b/libs/digger_config/yaml.go
@@ -43,6 +43,7 @@ type ProjectYaml struct {
 	Dir                  string                      `yaml:"dir"`
 	Workspace            string                      `yaml:"workspace"`
 	Terragrunt           bool                        `yaml:"terragrunt"`
+	Branch               *string                     `yaml:"branch,omitempty"`
 	OpenTofu             bool                        `yaml:"opentofu"`
 	Pulumi               bool                        `yaml:"pulumi"`
 	Workflow             string                      `yaml:"workflow"`
diff --git a/libs/orchestrator/mock.go b/libs/orchestrator/mock.go
@@ -96,9 +96,9 @@ func (mockGithubPullrequestManager *MockGithubPullrequestManager) CreateCommentR
 	return nil
 }
 
-func (mockGithubPullrequestManager *MockGithubPullrequestManager) GetBranchName(prNumber int) (string, string, error) {
+func (mockGithubPullrequestManager *MockGithubPullrequestManager) GetBranchName(prNumber int) (string, string, string, string, error) {
 	mockGithubPullrequestManager.commands = append(mockGithubPullrequestManager.commands, "GetBranchName")
-	return "", "", nil
+	return "", "", "", "", nil
 }
 
 func (mockGithubPullrequestManager MockGithubPullrequestManager) SetOutput(prNumber int, key string, value string) error {
diff --git a/next/controllers/github.go b/next/controllers/github.go
@@ -567,7 +567,7 @@ func getDiggerConfigForPR(gh next_utils.GithubClientProvider, installationId int
 	}
 
 	var prBranch string
-	prBranch, prCommitSha, err := ghService.GetBranchName(prNumber)
+	prBranch, prCommitSha, _, _, err := ghService.GetBranchName(prNumber)
 	if err != nil {
 		log.Printf("Error getting branch name: %v", err)
 		return "", nil, nil, nil, nil, nil, fmt.Errorf("error getting branch name")

Original file line number	Diff line number	Diff line change
`@@ -616,7 +616,7 @@ func getDiggerConfigForPR(gh utils.GithubClientProvider, orgId uint, prLabels []`
`616`	`616`	`}`
`617`	`617`
`618`	`618`	`var prBranch string`
`619`		`- prBranch, prCommitSha, err := ghService.GetBranchName(prNumber)`
	`619`	`+ prBranch, prCommitSha, _, _, err := ghService.GetBranchName(prNumber)`
`620`	`620`	`if err != nil {`
`621`	`621`	`slog.Error("Error getting branch name for PR",`
`622`	`622`	`"prNumber", prNumber,`
Original file line number	Diff line number	Diff line change
`@@ -164,9 +164,9 @@ func (m *MockPRManager) CreateCommentReaction(id string, reaction string) error`
`164`	`164`	`return nil`
`165`	`165`	`}`
`166`	`166`
`167`		`-func (m *MockPRManager) GetBranchName(prNumber int) (string, string, error) {`
	`167`	`+func (m *MockPRManager) GetBranchName(prNumber int) (string, string, string, string, error) {`
`168`	`168`	`m.Commands = append(m.Commands, RunInfo{"GetBranchName", strconv.Itoa(prNumber), time.Now()})`
`169`		`- return "", "", nil`
	`169`	`+ return "", "", "", "", nil`
`170`	`170`	`}`
`171`	`171`
`172`	`172`	`func (m *MockPRManager) SetOutput(prNumber int, key string, value string) error {`
Original file line number	Diff line number	Diff line change
`@@ -208,7 +208,7 @@ func handleIssueCommentEventBB(bitbucketProvider utils.BitbucketProvider, payloa`
`208`	`208`	`return fmt.Errorf("unknown digger command in comment %v", err)`
`209`	`209`	`}`
`210`	`210`
`211`		`- prBranchName, _, err := bbService.GetBranchName(issueNumber)`
	`211`	`+ prBranchName, _, _, _, err := bbService.GetBranchName(issueNumber)`
`212`	`212`	`if err != nil {`
`213`	`213`	`log.Printf("GetBranchName error: %v", err)`
`214`	`214`	`utils.InitCommentReporter(bbService, issueNumber, fmt.Sprintf(":x: GetBranchName error: %v", err))`
Original file line number	Diff line number	Diff line change
`@@ -356,9 +356,9 @@ func (a *AzureReposService) CreateCommentReaction(id string, reaction string) er`
`356`	`356`	`return nil`
`357`	`357`	`}`
`358`	`358`
`359`		`-func (a *AzureReposService) GetBranchName(prNumber int) (string, string, error) {`
	`359`	`+func (a *AzureReposService) GetBranchName(prNumber int) (string, string, string, string, error) {`
`360`	`360`	`//TODO implement me`
`361`		`- return "", "", nil`
	`361`	`+ return "", "", "", "", nil`
`362`	`362`	`}`
`363`	`363`
`364`	`364`	`func (svc *AzureReposService) SetOutput(prNumber int, key string, value string) error {`
Original file line number	Diff line number	Diff line change
`@@ -477,17 +477,17 @@ func (b BitbucketAPI) IsClosed(prNumber int) (bool, error) {`
`477`	`477`	`return pullRequest.State != "OPEN", nil`
`478`	`478`	`}`
`479`	`479`
`480`		`-func (b BitbucketAPI) GetBranchName(prNumber int) (string, string, error) {`
	`480`	`+func (b BitbucketAPI) GetBranchName(prNumber int) (string, string, string, string, error) {`
`481`	`481`	`url := fmt.Sprintf("%s/repositories/%s/%s/pullrequests/%d", bitbucketBaseURL, b.RepoWorkspace, b.RepoName, prNumber)`
`482`	`482`
`483`	`483`	`resp, err := b.sendRequest("GET", url, nil)`
`484`	`484`	`if err != nil {`
`485`		`- return "", "", err`
	`485`	`+ return "", "", "", "", err`
`486`	`486`	`}`
`487`	`487`	`defer resp.Body.Close()`
`488`	`488`
`489`	`489`	`if resp.StatusCode != http.StatusOK {`
`490`		`- return "", "", fmt.Errorf("failed to get pull request. Status code: %d", resp.StatusCode)`
	`490`	`+ return "", "", "", "", fmt.Errorf("failed to get pull request. Status code: %d", resp.StatusCode)`
`491`	`491`	`}`
`492`	`492`
`493`	`493`	`var pullRequest struct {`
`@@ -500,10 +500,10 @@ func (b BitbucketAPI) GetBranchName(prNumber int) (string, string, error) {`
`500`	`500`
`501`	`501`	`err = json.NewDecoder(resp.Body).Decode(&pullRequest)`
`502`	`502`	`if err != nil {`
`503`		`- return "", "", err`
	`503`	`+ return "", "", "", "", err`
`504`	`504`	`}`
`505`	`505`
`506`		`- return pullRequest.Source.Branch.Name, "", nil`
	`506`	`+ return pullRequest.Source.Branch.Name, "", "", "", nil`
`507`	`507`	`}`
`508`	`508`
`509`	`509`	`func (svc BitbucketAPI) SetOutput(prNumber int, key string, value string) error {`