patch promotion status with freight detail after git promote mechanis…

…m, add conventional method to add freight to promotion status

Signed-off-by: Nguyen Duy Phuong <knowledge.phuongnguyen@gmail.com>

api/v1alpha1/promotion_types.go

@@ -96,8 +96,8 @@ type PromotionStatus struct {
 	// Metadata holds arbitrary metadata set by promotion mechanisms
 	// (e.g. for display purposes, or internal bookkeeping)
 	Metadata map[string]string `json:"metadata,omitempty" protobuf:"bytes,3,rep,name=metadata" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
-	// PromotedFreight is the detail of the piece of freight that was referenced by this promotion.
-	PromotedFreight *FreightReference `json:"promotedFreight,omitempty" protobuf:"bytes,4,opt,name=promotedFreight"`
+	// Freight is the detail of the piece of freight that was referenced by this promotion.
+	Freight *FreightReference `json:"promotedFreight,omitempty" protobuf:"bytes,4,opt,name=freight"`
 }
 
 // WithPhase returns a copy of PromotionStatus with the given phase
@@ -107,6 +107,13 @@ func (p *PromotionStatus) WithPhase(phase PromotionPhase) *PromotionStatus {
 	return status
 }
 
+// WithFreight returns a copy of PromotionStatus with the given freight
+func (p *PromotionStatus) WithFreight(freight *FreightReference) *PromotionStatus {
+	status := p.DeepCopy()
+	status.Freight = freight
+	return status
+}
+
 // +kubebuilder:object:root=true
 
 // PromotionList contains a list of Promotion

charts/kargo/resources/crds/kargo.akuity.io_promotions.yaml

@@ -104,8 +104,8 @@ spec:
                   lifecycle.
                 type: string
               promotedFreight:
-                description: PromotedFreight is the detail of the piece of freight
-                  that was referenced by this promotion.
+                description: Freight is the detail of the piece of freight that was
+                  referenced by this promotion.
                 properties:
                   charts:
                     description: Charts describes specific versions of specific Helm

charts/kargo/resources/crds/kargo.akuity.io_stages.yaml

@@ -1001,8 +1001,8 @@ spec:
                           is in its lifecycle.
                         type: string
                       promotedFreight:
-                        description: PromotedFreight is the detail of the piece of
-                          freight that was referenced by this promotion.
+                        description: Freight is the detail of the piece of freight
+                          that was referenced by this promotion.
                         properties:
                           charts:
                             description: Charts describes specific versions of specific
@@ -1724,8 +1724,8 @@ spec:
                           is in its lifecycle.
                         type: string
                       promotedFreight:
-                        description: PromotedFreight is the detail of the piece of
-                          freight that was referenced by this promotion.
+                        description: Freight is the detail of the piece of freight
+                          that was referenced by this promotion.
                         properties:
                           charts:
                             description: Charts describes specific versions of specific

internal/controller/promotion/git.go

@@ -119,7 +119,7 @@ func (g *gitMechanism) Promote(
 		); err != nil {
 			return nil, newFreight, err
 		}
-		newStatus = aggregateGitPromoStatus(newStatus, *otherStatus)
+		newStatus = aggregateGitPromoStatus(newStatus, *otherStatus).WithFreight(&newFreight)
 	}
 
 	logger.Debugf("done executing %s", g.name)

internal/controller/promotions/promotions.go

@@ -389,7 +389,7 @@ func (r *reconciler) promote(
 		)
 	}
 	if targetFreight == nil {
-		return nil, fmt.Errorf("freight %q not found in namespace %q", promo.Spec.Freight, promo.Namespace)
+		return nil, fmt.Errorf("Freight %q not found in namespace %q", promo.Spec.Freight, promo.Namespace)
 	}
 	upstreamStages := make([]string, len(stage.Spec.Subscriptions.UpstreamStages))
 	for i, upstreamStage := range stage.Spec.Subscriptions.UpstreamStages {
@@ -423,10 +423,10 @@ func (r *reconciler) promote(
 	}
 	// record the freight reference to the promotion's status
 	err = kubeclient.PatchStatus(ctx, r.kargoClient, &promo, func(status *kargoapi.PromotionStatus) {
-		status.PromotedFreight = &targetFreightRef
+		status.Freight = &targetFreightRef
 	})
 	if err != nil {
-		return nil, err
+		logger.Errorf("Promotion status patch failed: %v", err)
 	}
 
 	newStatus, nextFreight, err := r.promoMechanisms.Promote(ctx, stage, &promo, targetFreightRef)

ui/src/gen/schema/promotions.kargo.akuity.io_v1alpha1.json

@@ -53,7 +53,7 @@
           "type": "string"
         },
         "promotedFreight": {
-          "description": "PromotedFreight is the detail of the piece of freight that was referenced by this promotion.",
+          "description": "Freight is the detail of the piece of freight that was referenced by this promotion.",
           "properties": {
             "charts": {
               "description": "Charts describes specific versions of specific Helm charts.",

ui/src/gen/schema/stages.kargo.akuity.io_v1alpha1.json

@@ -866,7 +866,7 @@
                   "type": "string"
                 },
                 "promotedFreight": {
-                  "description": "PromotedFreight is the detail of the piece of freight that was referenced by this promotion.",
+                  "description": "Freight is the detail of the piece of freight that was referenced by this promotion.",
                   "properties": {
                     "charts": {
                       "description": "Charts describes specific versions of specific Helm charts.",
@@ -1568,7 +1568,7 @@
                   "type": "string"
                 },
                 "promotedFreight": {
-                  "description": "PromotedFreight is the detail of the piece of freight that was referenced by this promotion.",
+                  "description": "Freight is the detail of the piece of freight that was referenced by this promotion.",
                   "properties": {
                     "charts": {
                       "description": "Charts describes specific versions of specific Helm charts.",

ui/src/gen/v1alpha1/generated_pb.ts

@@ -2874,11 +2874,11 @@ export class PromotionStatus extends Message<PromotionStatus> {
   metadata: { [key: string]: string } = {};
 
   /**
-   * PromotedFreight is the detail of the piece of freight that was referenced by this promotion.
+   * Freight is the detail of the piece of freight that was referenced by this promotion.
    *
-   * @generated from field: optional git.luolix.top.akuity.kargo.api.v1alpha1.FreightReference promotedFreight = 4;
+   * @generated from field: optional git.luolix.top.akuity.kargo.api.v1alpha1.FreightReference freight = 4;
    */
-  promotedFreight?: FreightReference;
+  freight?: FreightReference;
 
   constructor(data?: PartialMessage<PromotionStatus>) {
     super();
@@ -2891,7 +2891,7 @@ export class PromotionStatus extends Message<PromotionStatus> {
     { no: 1, name: "phase", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 2, name: "message", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 3, name: "metadata", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} },
-    { no: 4, name: "promotedFreight", kind: "message", T: FreightReference, opt: true },
+    { no: 4, name: "freight", kind: "message", T: FreightReference, opt: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PromotionStatus {