unhide release create --required flag, update tests, docs

Author: alicenstar

cli/cmd/release_create.go

@@ -51,7 +51,10 @@ func (r *runners) InitReleaseCreate(parent *cobra.Command) error {
       - ./manifests/*.yaml
 
   With this config, simply run:
-    replicated release create --version 1.0.0 --promote Unstable`,
+    replicated release create --version 1.0.0 --promote Unstable
+
+  To mark a release as required during upgrades:
+    replicated release create --version 1.0.0 --promote Unstable --required`,
 		SilenceUsage:  false,
 		SilenceErrors: true, // this command uses custom error printing
 	}
@@ -78,7 +81,6 @@ func (r *runners) InitReleaseCreate(parent *cobra.Command) error {
 	cmd.Flags().StringVarP(&r.outputFormat, "output", "o", "table", "The output format to use. One of: json|table")
 
 	// not supported for KOTS
-	cmd.Flags().MarkHidden("required")
 	cmd.Flags().MarkHidden("yaml-file")
 	cmd.Flags().MarkHidden("yaml")
 	cmd.Flags().MarkHidden("chart")
@@ -506,6 +508,11 @@ func (r *runners) validateReleaseCreateParams() error {
 		return errors.Errorf("the flag --ensure-channel is only supported for KOTS applications, app %q is of type %q", r.appID, r.appType)
 	}
 
+	// can't mark a release as required if you didn't pass a promote channel
+	if r.args.createReleasePromoteRequired && r.args.createReleasePromote == "" {
+		return errors.New("--required can only be used with --promote <channel>")
+	}
+
 	return nil
 }
 

cli/cmd/release_create_test.go

@@ -220,3 +220,47 @@ func TestSetKOTSDefaultReleaseParams_SetsEnsureChannelAndLint(t *testing.T) {
 	assert.True(t, args.createReleasePromoteEnsureChannel, "ensure-channel should be set to true")
 	assert.True(t, args.createReleaseLint, "lint should be set to true")
 }
+
+// TestRequiredFlagRequiresPromote tests that --required fails without --promote
+func TestRequiredFlagRequiresPromote(t *testing.T) {
+	r := &runners{
+		args: runnerArgs{
+			createReleasePromoteRequired: true,
+			createReleasePromote:         "", // No promote channel
+			createReleaseYamlDir:         "./manifests",
+		},
+		appType: "kots",
+	}
+
+	err := r.validateReleaseCreateParams()
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "--required can only be used with --promote")
+}
+
+// TestRequiredFlagWithPromote tests that --required works with --promote
+func TestRequiredFlagWithPromote(t *testing.T) {
+	r := &runners{
+		args: runnerArgs{
+			createReleasePromoteRequired: true,
+			createReleasePromote:         "Unstable",
+			createReleaseYamlDir:         "./manifests",
+		},
+		appType: "kots",
+	}
+
+	err := r.validateReleaseCreateParams()
+	assert.NoError(t, err)
+}
+
+// TestRequiredFlagDefaultsFalse tests that --required defaults to false
+func TestRequiredFlagDefaultsFalse(t *testing.T) {
+	r := &runners{
+		args: runnerArgs{
+			createReleasePromote: "Unstable",
+			createReleaseYamlDir: "./manifests",
+		},
+	}
+
+	assert.False(t, r.args.createReleasePromoteRequired,
+		"--required should default to false")
+}