feat(nelm): show NOTES.txt on release

Signed-off-by: Ilya Lesikov <ilya@lesikov.com>

Author: ilya-lesikov

cmd/werf/converge/converge.go

@@ -637,6 +637,8 @@ func run(ctx context.Context, containerBackend container_backend.ContainerBacken
 				return fmt.Errorf("error constructing chart tree: %w", err)
 			}
 
+			notes := chartTree.Notes()
+
 			var prevRelGeneralResources []*resrc.GeneralResource
 			if prevReleaseFound {
 				prevRelGeneralResources = prevRelease.GeneralResources()
@@ -679,7 +681,7 @@ func run(ctx context.Context, containerBackend container_backend.ContainerBacken
 			}
 
 			log.Default.Info(ctx, "Constructing new release")
-			newRel, err := rls.NewRelease(releaseName, releaseNamespace.Name(), newRevision, chartTree.ReleaseValues(), chartTree.LegacyChart(), resProcessor.ReleasableHookResources(), resProcessor.ReleasableGeneralResources(), chartTree.Notes(), rls.ReleaseOptions{
+			newRel, err := rls.NewRelease(releaseName, releaseNamespace.Name(), newRevision, chartTree.ReleaseValues(), chartTree.LegacyChart(), resProcessor.ReleasableHookResources(), resProcessor.ReleasableGeneralResources(), notes, rls.ReleaseOptions{
 				FirstDeployed: firstDeployed,
 				Mapper:        clientFactory.Mapper(),
 			})
@@ -746,6 +748,7 @@ func run(ctx context.Context, containerBackend container_backend.ContainerBacken
 			if useless, err := plan.Useless(); err != nil {
 				return fmt.Errorf("error checking if deploy plan will do nothing useful: %w", err)
 			} else if useless {
+				printNotes(ctx, notes)
 				log.Default.Info(ctx, color.Style{color.Bold, color.Green}.Render("Skipped release")+" %q (namespace: %q): cluster resources already as desired", releaseName, releaseNamespace.Name())
 				return nil
 			}
@@ -842,7 +845,7 @@ func run(ctx context.Context, containerBackend container_backend.ContainerBacken
 				nonCriticalErrs = append(nonCriticalErrs, noncriterrs...)
 
 				if cmdData.AutoRollback && prevDeployedReleaseFound {
-					wcompops, wfailops, wcancops, criterrs, noncriterrs = runRollbackPlan(
+					wcompops, wfailops, wcancops, notes, criterrs, noncriterrs = runRollbackPlan(
 						ctx,
 						taskStore,
 						logStore,
@@ -889,6 +892,10 @@ func run(ctx context.Context, containerBackend container_backend.ContainerBacken
 				}
 			}
 
+			if len(criticalErrs) == 0 {
+				printNotes(ctx, notes)
+			}
+
 			if len(criticalErrs) > 0 {
 				return utls.Multierrorf("failed release %q (namespace: %q)", append(criticalErrs, nonCriticalErrs...), releaseName, releaseNamespace.Name())
 			} else if len(nonCriticalErrs) > 0 {
@@ -1006,7 +1013,7 @@ func runRollbackPlan(
 	rollbackGraphPath string,
 	networkParallelism int,
 ) (
-	worthyCompletedOps, worthyFailedOps, worthyCanceledOps []opertn.Operation,
+	worthyCompletedOps, worthyFailedOps, worthyCanceledOps []opertn.Operation, notes string,
 	criticalErrs, nonCriticalErrs []error,
 ) {
 	log.Default.Info(ctx, "Processing rollback resources")
@@ -1042,7 +1049,7 @@ func runRollbackPlan(
 	)
 
 	if err := resProcessor.Process(ctx); err != nil {
-		return nil, nil, nil, []error{fmt.Errorf("error processing rollback resources: %w", err)}, nonCriticalErrs
+		return nil, nil, nil, "", []error{fmt.Errorf("error processing rollback resources: %w", err)}, nonCriticalErrs
 	}
 
 	rollbackRevision := failedRevision + 1
@@ -1063,7 +1070,7 @@ func runRollbackPlan(
 		},
 	)
 	if err != nil {
-		return nil, nil, nil, []error{fmt.Errorf("error constructing rollback release: %w", err)}, nonCriticalErrs
+		return nil, nil, nil, "", []error{fmt.Errorf("error constructing rollback release: %w", err)}, nonCriticalErrs
 	}
 
 	log.Default.Info(ctx, "Constructing rollback plan")
@@ -1094,7 +1101,7 @@ func runRollbackPlan(
 
 	rollbackPlan, err := rollbackPlanBuilder.Build(ctx)
 	if err != nil {
-		return nil, nil, nil, []error{fmt.Errorf("error building rollback plan: %w", err)}, nonCriticalErrs
+		return nil, nil, nil, "", []error{fmt.Errorf("error building rollback plan: %w", err)}, nonCriticalErrs
 	}
 
 	if saveRollbackGraph {
@@ -1104,10 +1111,10 @@ func runRollbackPlan(
 	}
 
 	if useless, err := rollbackPlan.Useless(); err != nil {
-		return nil, nil, nil, []error{fmt.Errorf("error checking if rollback plan will do nothing useful: %w", err)}, nonCriticalErrs
+		return nil, nil, nil, "", []error{fmt.Errorf("error checking if rollback plan will do nothing useful: %w", err)}, nonCriticalErrs
 	} else if useless {
 		log.Default.Info(ctx, color.Style{color.Bold, color.Green}.Render("Skipped rollback release")+" %q (namespace: %q): cluster resources already as desired", releaseName, releaseNamespace.Name())
-		return nil, nil, nil, criticalErrs, nonCriticalErrs
+		return nil, nil, nil, "", criticalErrs, nonCriticalErrs
 	}
 
 	log.Default.Info(ctx, "Executing rollback plan")
@@ -1166,7 +1173,7 @@ func runRollbackPlan(
 		nonCriticalErrs = append(nonCriticalErrs, noncriterrs...)
 	}
 
-	return worthyCompletedOps, worthyFailedOps, worthyCanceledOps, criticalErrs, nonCriticalErrs
+	return worthyCompletedOps, worthyFailedOps, worthyCanceledOps, rollbackRel.Notes(), criticalErrs, nonCriticalErrs
 }
 
 func printTables(ctx context.Context, tablesBuilder *track.TablesBuilder) {
@@ -1314,3 +1321,13 @@ func checkHelm3ReleaseExists(ctx context.Context, releaseName, namespace string,
 
 	return foundHelm3Release, nil
 }
+
+func printNotes(ctx context.Context, notes string) {
+	if notes == "" {
+		return
+	}
+
+	log.Default.InfoBlock(ctx, color.Style{color.Bold, color.Blue}.Render("Release notes")).Do(func() {
+		log.Default.Info(ctx, notes)
+	})
+}

go.mod

@@ -65,7 +65,7 @@ require (
 	github.com/werf/kubedog v0.12.4-0.20240229114338-b4b4fe4011fe
 	github.com/werf/lockgate v0.1.1
 	github.com/werf/logboek v0.6.1
-	github.com/werf/nelm v0.0.0-20240307093820-a630e7887ba2
+	github.com/werf/nelm v0.0.0-20240307103636-81088a0ff3f0
 	go.opentelemetry.io/otel v1.21.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.21.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.21.0

go.sum

@@ -1558,8 +1558,8 @@ github.com/werf/lockgate v0.1.1 h1:S400JFYjtWfE4i4LY9FA8zx0fMdfui9DPrBiTciCrx4=
 github.com/werf/lockgate v0.1.1/go.mod h1:0yIFSLq9ausy6ejNxF5uUBf/Ib6daMAfXuCaTMZJzIE=
 github.com/werf/logboek v0.6.1 h1:oEe6FkmlKg0z0n80oZjLplj6sXcBeLleCkjfOOZEL2g=
 github.com/werf/logboek v0.6.1/go.mod h1:Gez5J4bxekyr6MxTmIJyId1F61rpO+0/V4vjCIEIZmk=
-github.com/werf/nelm v0.0.0-20240307093820-a630e7887ba2 h1:RzJNNLwIDsLhdEXP9s9i0m6X7Td2fr636bXzhACCKw4=
-github.com/werf/nelm v0.0.0-20240307093820-a630e7887ba2/go.mod h1:JJkG5txk0x4uV8oFh0J/Ow260K8bhe3QeOlaBCHWHJw=
+github.com/werf/nelm v0.0.0-20240307103636-81088a0ff3f0 h1:KmVMyRSOET5mo1YuY3SmxAUvw5os5nXBWLGsyYAHa9s=
+github.com/werf/nelm v0.0.0-20240307103636-81088a0ff3f0/go.mod h1:JJkG5txk0x4uV8oFh0J/Ow260K8bhe3QeOlaBCHWHJw=
 github.com/xanzy/go-gitlab v0.31.0/go.mod h1:sPLojNBn68fMUWSxIJtdVVIP8uSBYqesTfDUseX11Ug=
 github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4=
 github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=