Deprecate --chart flag (#413)

Author: divolgin

cli/cmd/cluster_prepare.go

@@ -91,6 +91,8 @@ replicated cluster prepare --distribution eks --version 1.27 --instance-type c6.
 
 	// for builders plan (chart only)
 	cmd.Flags().StringVar(&r.args.prepareClusterChart, "chart", "", "Path to the helm chart package to deploy")
+	cmd.Flags().MarkHidden("chart")
+
 	addValueOptionsFlags(cmd.Flags(), &r.args.prepareClusterValueOpts)
 
 	cmd.Flags().StringVar(&r.args.prepareClusterNamespace, "namespace", "default", "The namespace into which to deploy the KOTS application or Helm chart.")
@@ -130,6 +132,7 @@ func validateClusterPrepareFlags(args runnerArgs) error {
 	}
 
 	if args.prepareClusterChart != "" {
+		printChartDeprecationWarning()
 		if args.prepareClusterKotsSharedPassword != "" {
 			return errors.New("The --shared-password flag cannot be used when deploying a Helm chart")
 		}
@@ -309,6 +312,7 @@ func prepareRelease(r *runners, log *logger.Logger) (*types.ReleaseInfo, error)
 	}
 
 	if r.args.prepareClusterChart != "" {
+		printChartDeprecationWarning()
 		fmt.Fprintln(r.w)
 		log.ActionWithSpinner("Reading chart from %s", r.args.prepareClusterChart)
 		var err error

cli/cmd/release_create.go

@@ -59,6 +59,9 @@ func (r *runners) InitReleaseCreate(parent *cobra.Command) error {
 	cmd.Flags().MarkHidden("yaml-file")
 	cmd.Flags().MarkHidden("yaml")
 
+	// deprecated
+	cmd.Flags().MarkHidden("chart")
+
 	cmd.RunE = r.releaseCreate
 	return nil
 }
@@ -242,6 +245,8 @@ Prepared to create release with defaults:
 	}
 
 	if r.args.createReleaseChart != "" {
+		printChartDeprecationWarning()
+
 		fmt.Fprint(r.w, "You are creating a release that will only be installable with the helm CLI.\n"+
 			"For more information, see \n"+
 			"https://docs.replicated.com/vendor/helm-install#about-helm-installations-with-replicated\n")

cli/cmd/release_lint.go

@@ -37,6 +37,9 @@ func (r *runners) InitReleaseLint(parent *cobra.Command) {
 	cmd.Flags().StringVar(&r.args.lintReleaseFailOn, "fail-on", "error", "The minimum severity to cause the command to exit with a non-zero exit code. Supported values are [info, warn, error, none].")
 	cmd.Flags().StringVar(&r.outputFormat, "output", "table", "The output format to use. One of: json|table (default: table)")
 
+	// deprecated
+	cmd.Flags().MarkHidden("chart")
+
 	cmd.RunE = r.releaseLint
 }
 
@@ -60,6 +63,7 @@ func (r *runners) releaseLint(cmd *cobra.Command, args []string) error {
 		isBuildersRelease = isHelmChartsOnly
 		contentType = "application/tar"
 	} else if r.args.lintReleaseChart != "" {
+		printChartDeprecationWarning()
 		data, err := os.ReadFile(r.args.lintReleaseChart)
 		if err != nil {
 			return errors.Wrap(err, "failed to read chart file")

cli/cmd/release_update.go

@@ -24,6 +24,9 @@ func (r *runners) InitReleaseUpdate(parent *cobra.Command) {
 	cmd.Flags().StringVar(&r.args.updateReleaseYamlDir, "yaml-dir", "", "The directory containing multiple yamls for a Kots release. Cannot be used with the --yaml flag.")
 	cmd.Flags().StringVar(&r.args.updateReleaseChart, "chart", "", "Helm chart to create the release from. Cannot be used with the --yaml, --yaml-file, or --yaml-dir flags.")
 
+	// deprecated
+	cmd.Flags().MarkHidden("chart")
+
 	cmd.RunE = r.releaseUpdate
 }
 
@@ -85,6 +88,7 @@ func (r *runners) releaseUpdate(cmd *cobra.Command, args []string) error {
 			return errors.Wrap(err, "make release from dir")
 		}
 	} else if r.args.updateReleaseChart != "" {
+		printChartDeprecationWarning()
 		r.args.updateReleaseYaml, err = makeReleaseFromChart(r.args.updateReleaseChart)
 		if err != nil {
 			return errors.Wrap(err, "make release from chart")

cli/cmd/root.go

@@ -8,6 +8,7 @@ import (
 	"strings"
 	"text/tabwriter"
 
+	"github.com/fatih/color"
 	"github.com/pkg/errors"
 
 	"github.com/replicatedhq/replicated/pkg/credentials"
@@ -364,6 +365,11 @@ func printIfError(cmd *cobra.Command, err error) {
 	}
 }
 
+func printChartDeprecationWarning() {
+	red := color.New(color.FgHiRed)
+	red.Fprintf(os.Stderr, "\nThe --chart flag is deprecated and will be removed in a future release. Please use the --yaml or --yaml-dir flag instead.\n\n")
+}
+
 func parseTags(tags []string) ([]types.Tag, error) {
 	parsedTags := []types.Tag{}
 	for _, tag := range tags {