feat: add filter path support

Author: zachaller

api/v1alpha1/changetransferpolicy_types.go

@@ -51,6 +51,9 @@ type ChangeTransferPolicySpec struct {
 	// ProposedCommitStatuses lists the statuses to be monitored on the proposed branch
 	// +kubebuilder:validation:Optional
 	ProposedCommitStatuses []CommitStatusSelector `json:"proposedCommitStatuses"`
+
+	// +kubebuilder:validation:Optional
+	OpenPullerRequestFilter *OpenPullerRequestFilter `json:"openPullRequestFilter,omitempty"`
 }
 
 type ChangeRequestPolicyCommitStatusPhase struct {

api/v1alpha1/common_types.go

@@ -12,3 +12,7 @@ type ObjectReference struct {
 	// +kubebuilder:validation:Required
 	Name string `json:"name"`
 }
+
+type OpenPullerRequestFilter struct {
+	Paths []string `json:"paths,omitempty"`
+}

api/v1alpha1/promotionstrategy_types.go

@@ -51,6 +51,9 @@ type PromotionStrategySpec struct {
 	// Environments is the sequence of environments that a dry commit will be promoted through.
 	// +kubebuilder:validation:MinItems:=1
 	Environments []Environment `json:"environments"`
+
+	// +kubebuilder:validation:Optional
+	OpenPullerRequestFilter *OpenPullerRequestFilter `json:"openPullRequestFilter,omitempty"`
 }
 
 type Environment struct {

api/v1alpha1/zz_generated.deepcopy.go

@@ -73,6 +73,13 @@ spec:
                 required:
                 - name
                 type: object
+              openPullRequestFilter:
+                properties:
+                  paths:
+                    items:
+                      type: string
+                    type: array
+                type: object
               proposedBranch:
                 description: ProposedBranch staging hydrated branch
                 type: string

config/crd/bases/promoter.argoproj.io_changetransferpolicies.yaml

@@ -120,6 +120,13 @@ spec:
                 required:
                 - name
                 type: object
+              openPullRequestFilter:
+                properties:
+                  paths:
+                    items:
+                      type: string
+                    type: array
+                type: object
               proposedCommitStatuses:
                 description: |-
                   ProposedCommitStatuses are commit statuses describing a proposed dry commit, i.e. one that is not yet running

config/crd/bases/promoter.argoproj.io_promotionstrategies.yaml

@@ -85,6 +85,13 @@ spec:
                 required:
                 - name
                 type: object
+              openPullRequestFilter:
+                properties:
+                  paths:
+                    items:
+                      type: string
+                    type: array
+                type: object
               proposedBranch:
                 description: ProposedBranch staging hydrated branch
                 type: string
@@ -492,6 +499,13 @@ spec:
                 required:
                 - name
                 type: object
+              openPullRequestFilter:
+                properties:
+                  paths:
+                    items:
+                      type: string
+                    type: array
+                type: object
               proposedCommitStatuses:
                 description: |-
                   ProposedCommitStatuses are commit statuses describing a proposed dry commit, i.e. one that is not yet running

dist/install.yaml

@@ -308,7 +308,7 @@ func (r *ChangeTransferPolicyReconciler) mergeOrPullRequestPromote(ctx context.C
 		return nil
 	}
 
-	prRequired, err := gitOperations.IsPullRequestRequired(ctx, ctp.Spec.ProposedBranch, ctp.Spec.ActiveBranch)
+	prRequired, err := gitOperations.IsPullRequestRequired(ctx, ctp.Spec.OpenPullerRequestFilter, ctp.Spec.ProposedBranch, ctp.Spec.ActiveBranch)
 	if err != nil {
 		return fmt.Errorf("failed to check whether a PR is required from branch %q to %q: %w", ctp.Spec.ProposedBranch, ctp.Spec.ActiveBranch, err)
 	}

internal/controller/changetransferpolicy_controller.go

@@ -155,12 +155,13 @@ func (r *PromotionStrategyReconciler) upsertChangeTransferPolicy(ctx context.Con
 			},
 		},
 		Spec: promoterv1alpha1.ChangeTransferPolicySpec{
-			RepositoryReference:    ps.Spec.RepositoryReference,
-			ProposedBranch:         fmt.Sprintf("%s-%s", environment.Branch, "next"),
-			ActiveBranch:           environment.Branch,
-			ActiveCommitStatuses:   append(environment.ActiveCommitStatuses, ps.Spec.ActiveCommitStatuses...),
-			ProposedCommitStatuses: append(environment.ProposedCommitStatuses, ps.Spec.ProposedCommitStatuses...),
-			AutoMerge:              environment.AutoMerge,
+			RepositoryReference:     ps.Spec.RepositoryReference,
+			ProposedBranch:          fmt.Sprintf("%s-%s", environment.Branch, "next"),
+			ActiveBranch:            environment.Branch,
+			ActiveCommitStatuses:    append(environment.ActiveCommitStatuses, ps.Spec.ActiveCommitStatuses...),
+			ProposedCommitStatuses:  append(environment.ProposedCommitStatuses, ps.Spec.ProposedCommitStatuses...),
+			AutoMerge:               environment.AutoMerge,
+			OpenPullerRequestFilter: ps.Spec.OpenPullerRequestFilter,
 		},
 	}