Merge pull request #23 from spinkube/experimental

mark some CLI commands as experimental
spinkube · Feb 21, 2024 · 45f2431 · 45f2431
2 parents 1e59dbe + d3130db
commit 45f2431
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 12 deletions.
diff --git a/pkg/cmd/connect.go b/pkg/cmd/connect.go
@@ -18,8 +18,9 @@ import (
 const spinAppPort = "80"
 
 var connectCmd = &cobra.Command{
-	Use:   "connect [<app-name>]",
-	Short: "connect to spin app locally",
+	Use:    "connect [<app-name>]",
+	Short:  "connect to spin app locally",
+	Hidden: isExperimentalFlagNotSet,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		var appName string
 		if len(args) > 0 {

diff --git a/pkg/cmd/delete.go b/pkg/cmd/delete.go
@@ -11,8 +11,9 @@ import (
 )
 
 var deleteCmd = &cobra.Command{
-	Use:   "delete app-name",
-	Short: "Delete app",
+	Use:    "delete app-name",
+	Short:  "Delete app",
+	Hidden: isExperimentalFlagNotSet,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		var appName string
 		if len(args) > 0 {

diff --git a/pkg/cmd/deploy.go b/pkg/cmd/deploy.go
@@ -19,8 +19,9 @@ var (
 )
 
 var deployCmd = &cobra.Command{
-	Use:   "deploy",
-	Short: "deploy spin app",
+	Use:    "deploy",
+	Short:  "deploy spin app",
+	Hidden: isExperimentalFlagNotSet,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		reference := strings.Split(artifact, ":")[0]
 		referenceParts := strings.Split(reference, "/")

diff --git a/pkg/cmd/get.go b/pkg/cmd/get.go
@@ -9,8 +9,9 @@ import (
 )
 
 var getCmd = &cobra.Command{
-	Use:   "get [app-name]",
-	Short: "Display detailed information about an app",
+	Use:    "get [app-name]",
+	Short:  "Display detailed information about an app",
+	Hidden: isExperimentalFlagNotSet,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		var appName string
 		if len(args) > 0 {

diff --git a/pkg/cmd/list.go b/pkg/cmd/list.go
@@ -8,8 +8,9 @@ import (
 )
 
 var listCmd = &cobra.Command{
-	Use:   "list",
-	Short: "List apps",
+	Use:    "list",
+	Short:  "List apps",
+	Hidden: isExperimentalFlagNotSet,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		appsResp, err := k8simpl.ListSpinApps(context.TODO(), namespace)
 		if err != nil {

diff --git a/pkg/cmd/logs.go b/pkg/cmd/logs.go
@@ -11,8 +11,9 @@ import (
 var logOpts *logs.LogsOptions
 
 var logsCmd = &cobra.Command{
-	Use:   "logs [<app-name>]",
-	Short: "print the logs for a SpinApp",
+	Use:    "logs [<app-name>]",
+	Short:  "print the logs for a SpinApp",
+	Hidden: isExperimentalFlagNotSet,
 	Run: func(cmd *cobra.Command, args []string) {
 		var appName string
 		if len(args) > 0 {

diff --git a/pkg/cmd/root.go b/pkg/cmd/root.go
@@ -18,6 +18,7 @@ var (
 	configFlags                  = genericclioptions.NewConfigFlags(true)
 	namespace                    string
 	k8simpl                      *k8s.Impl
+	isExperimentalFlagNotSet     = os.Getenv("SPIN_EXPERIMENTAL") == ""
 )
 
 // rootCmd represents the base command when called without any subcommands