diff --git a/README.md b/README.md index 652ef304..cbc98c67 100644 --- a/README.md +++ b/README.md @@ -327,7 +327,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an account", Long: "Create an account in Octopus Deploy", - Example: heredoc.Docf("$ %s account create", constants.ExecutableName), + Example: heredoc.Docf("%s account create", constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { return nil // TODO }, diff --git a/cmd/gen-docs/main.go b/cmd/gen-docs/main.go index fd7314d0..ea32ea54 100644 --- a/cmd/gen-docs/main.go +++ b/cmd/gen-docs/main.go @@ -201,7 +201,7 @@ navOrder: {{.Position}} import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; {{.Command.Long}} -` + "\n```" + `{{define "T1"}}Usage:{{if .Runnable}} +` + "\n```text" + `{{define "T1"}}Usage:{{if .Runnable}} {{.UseLine}}{{end}}{{if .HasAvailableSubCommands}} {{.CommandPath}} [command]{{end}}{{if gt (len .Aliases) 0}} @@ -233,7 +233,7 @@ Use "{{.CommandPath}} [command] --help" for more information about a command.{{e ## Examples -` + "\n```" + ` +` + "\n```bash" + ` {{ .Command.Example }} ` + "\n```\n" + ` {{- end }} @@ -241,7 +241,8 @@ Use "{{.CommandPath}} [command] --help" for more information about a command.{{e ## Learn more - [Octopus CLI](/docs/octopus-rest-api/cli) -- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)` +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) +` const indexTemplate = `--- layout: src/layouts/Default.astro @@ -263,7 +264,8 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al ## Commands {#octopusCommandLine-Commands} -` + "\n`octopus` supports the following commands:\n" + +` + "`octopus` supports the following commands:" + ` {{range .Pages}} -- **[{{.Title}}]({{.RelativePath}})**: {{.Command.Short}}.{{end}}` +- **[{{.Title}}]({{.RelativePath}})**: {{.Command.Short}}.{{end}} +` diff --git a/pkg/cmd/account/account.go b/pkg/cmd/account/account.go index 76e04ec9..7367c430 100644 --- a/pkg/cmd/account/account.go +++ b/pkg/cmd/account/account.go @@ -24,7 +24,7 @@ func NewCmdAccount(f factory.Factory) *cobra.Command { Use: "account ", Short: "Manage accounts", Long: "Manage accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account list", constants.ExecutableName), + Example: heredoc.Docf("%s account list", constants.ExecutableName), Annotations: map[string]string{ annotations.IsInfrastructure: "true", }, diff --git a/pkg/cmd/account/aws/aws.go b/pkg/cmd/account/aws/aws.go index 4bd394fb..f3f920ed 100644 --- a/pkg/cmd/account/aws/aws.go +++ b/pkg/cmd/account/aws/aws.go @@ -14,7 +14,7 @@ func NewCmdAws(f factory.Factory) *cobra.Command { Use: "aws ", Short: "Manage AWS accounts", Long: "Manage AWS accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account aws list", constants.ExecutableName), + Example: heredoc.Docf("%s account aws list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/account/aws/create/create.go b/pkg/cmd/account/aws/create/create.go index a1fb60ee..0bf3f548 100644 --- a/pkg/cmd/account/aws/create/create.go +++ b/pkg/cmd/account/aws/create/create.go @@ -2,9 +2,10 @@ package create import ( "fmt" - "github.com/OctopusDeploy/cli/pkg/cmd" "os" + "github.com/OctopusDeploy/cli/pkg/cmd" + "github.com/OctopusDeploy/cli/pkg/util" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" @@ -67,7 +68,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an AWS account", Long: "Create an AWS account in Octopus Deploy", - Example: heredoc.Docf("$ %s account aws create", constants.ExecutableName), + Example: heredoc.Docf("%s account aws create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/aws/list/list.go b/pkg/cmd/account/aws/list/list.go index aa70d92e..c55ef2e4 100644 --- a/pkg/cmd/account/aws/list/list.go +++ b/pkg/cmd/account/aws/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List AWS accounts", Long: "List AWS accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account aws list", constants.ExecutableName), + Example: heredoc.Docf("%s account aws list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, _ []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/azure-oidc/azure-oidc.go b/pkg/cmd/account/azure-oidc/azure-oidc.go index d9f85a53..87002a8a 100644 --- a/pkg/cmd/account/azure-oidc/azure-oidc.go +++ b/pkg/cmd/account/azure-oidc/azure-oidc.go @@ -14,7 +14,7 @@ func NewCmdAzureOidc(f factory.Factory) *cobra.Command { Use: "azure-oidc ", Short: "Manage Azure OpenID Connect accounts", Long: "Manage Azure OpenID Connect accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account azure-oidc list", constants.ExecutableName), + Example: heredoc.Docf("%s account azure-oidc list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/account/azure-oidc/create/create.go b/pkg/cmd/account/azure-oidc/create/create.go index cf625a64..9c767e41 100644 --- a/pkg/cmd/account/azure-oidc/create/create.go +++ b/pkg/cmd/account/azure-oidc/create/create.go @@ -2,11 +2,12 @@ package create import ( "fmt" + "os" + "strings" + "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/account/shared" "github.com/OctopusDeploy/cli/pkg/question" - "os" - "strings" "github.com/OctopusDeploy/cli/pkg/util" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" @@ -84,7 +85,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an Azure OpenID Connect account", Long: "Create an Azure OpenID Connect account in Octopus Deploy", - Example: heredoc.Docf("$ %s account azure-oidc create", constants.ExecutableName), + Example: heredoc.Docf("%s account azure-oidc create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/azure-oidc/list/list.go b/pkg/cmd/account/azure-oidc/list/list.go index 1e1f08c0..f68f76bb 100644 --- a/pkg/cmd/account/azure-oidc/list/list.go +++ b/pkg/cmd/account/azure-oidc/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List Azure OpenID Connect accounts", Long: "List Azure OpenID Connect accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account azure-oidc list", constants.ExecutableName), + Example: heredoc.Docf("%s account azure-oidc list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/azure/azure.go b/pkg/cmd/account/azure/azure.go index 8e0304d5..da0e85b8 100644 --- a/pkg/cmd/account/azure/azure.go +++ b/pkg/cmd/account/azure/azure.go @@ -14,7 +14,7 @@ func NewCmdAzure(f factory.Factory) *cobra.Command { Use: "azure ", Short: "Manage Azure subscription accounts", Long: "Manage Azure subscription accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account azure list", constants.ExecutableName), + Example: heredoc.Docf("%s account azure list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/account/azure/create/create.go b/pkg/cmd/account/azure/create/create.go index 120874c8..76fec331 100644 --- a/pkg/cmd/account/azure/create/create.go +++ b/pkg/cmd/account/azure/create/create.go @@ -2,11 +2,12 @@ package create import ( "fmt" - "github.com/OctopusDeploy/cli/pkg/cmd" - "github.com/OctopusDeploy/cli/pkg/cmd/account/shared" "os" "strings" + "github.com/OctopusDeploy/cli/pkg/cmd" + "github.com/OctopusDeploy/cli/pkg/cmd/account/shared" + "github.com/OctopusDeploy/cli/pkg/util" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" @@ -78,7 +79,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an Azure subscription account", Long: "Create an Azure subscription account in Octopus Deploy", - Example: heredoc.Docf("$ %s account azure create", constants.ExecutableName), + Example: heredoc.Docf("%s account azure create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/azure/list/list.go b/pkg/cmd/account/azure/list/list.go index fbcf1a8b..59e91b0b 100644 --- a/pkg/cmd/account/azure/list/list.go +++ b/pkg/cmd/account/azure/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List Azure subscription accounts", Long: "List Azure subscription accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account azure list", constants.ExecutableName), + Example: heredoc.Docf("%s account azure list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/create/create.go b/pkg/cmd/account/create/create.go index 92df18d1..f58f44de 100644 --- a/pkg/cmd/account/create/create.go +++ b/pkg/cmd/account/create/create.go @@ -2,6 +2,7 @@ package create import ( "fmt" + "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" @@ -32,7 +33,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an account", Long: "Create an account in Octopus Deploy", - Example: heredoc.Docf("$ %s account create", constants.ExecutableName), + Example: heredoc.Docf("%s account create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(cmd *cobra.Command, args []string) error { return createRun(f, cmd) diff --git a/pkg/cmd/account/delete/delete.go b/pkg/cmd/account/delete/delete.go index 1a62f40d..f0c4402f 100644 --- a/pkg/cmd/account/delete/delete.go +++ b/pkg/cmd/account/delete/delete.go @@ -2,6 +2,7 @@ package delete import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/constants" @@ -21,8 +22,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete an account in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s account delete - $ %[1]s account rm + %[1]s account delete + %[1]s account rm `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { if len(args) == 0 { diff --git a/pkg/cmd/account/gcp/create/create.go b/pkg/cmd/account/gcp/create/create.go index 693e6afa..2c2a5083 100644 --- a/pkg/cmd/account/gcp/create/create.go +++ b/pkg/cmd/account/gcp/create/create.go @@ -3,9 +3,10 @@ package create import ( b64 "encoding/base64" "fmt" - "github.com/OctopusDeploy/cli/pkg/cmd" "os" + "github.com/OctopusDeploy/cli/pkg/cmd" + "github.com/OctopusDeploy/cli/pkg/util" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" @@ -66,7 +67,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a Google Cloud account", Long: "Create a Google Cloud account in Octopus Deploy", - Example: heredoc.Docf("$ %s account gcp create", constants.ExecutableName), + Example: heredoc.Docf("%s account gcp create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/gcp/gcp.go b/pkg/cmd/account/gcp/gcp.go index 063bac51..ccdb568a 100644 --- a/pkg/cmd/account/gcp/gcp.go +++ b/pkg/cmd/account/gcp/gcp.go @@ -14,7 +14,7 @@ func NewCmdGcp(f factory.Factory) *cobra.Command { Use: "gcp ", Short: "Manage Google Cloud accounts", Long: "Manage Google Cloud accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account gcp list", constants.ExecutableName), + Example: heredoc.Docf("%s account gcp list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/account/gcp/list/list.go b/pkg/cmd/account/gcp/list/list.go index 820d293f..61ca22b9 100644 --- a/pkg/cmd/account/gcp/list/list.go +++ b/pkg/cmd/account/gcp/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List Google Cloud accounts", Long: "List Google Cloud accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account gcp list", constants.ExecutableName), + Example: heredoc.Docf("%s account gcp list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, _ []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/generic-oidc/create/create.go b/pkg/cmd/account/generic-oidc/create/create.go index da2ae1b7..402cd929 100644 --- a/pkg/cmd/account/generic-oidc/create/create.go +++ b/pkg/cmd/account/generic-oidc/create/create.go @@ -2,6 +2,8 @@ package create import ( "fmt" + "os" + "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" @@ -18,7 +20,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/accounts" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" "github.com/spf13/cobra" - "os" ) type CreateFlags struct { @@ -63,7 +64,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an Generic OpenID Connect account", Long: "Create an Generic OpenID Connect account in Octopus Deploy", - Example: heredoc.Docf("$ %s account generic-oidc create", constants.ExecutableName), + Example: heredoc.Docf("%s account generic-oidc create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/generic-oidc/generic-oidc.go b/pkg/cmd/account/generic-oidc/generic-oidc.go index 05e1dfc7..31faffcf 100644 --- a/pkg/cmd/account/generic-oidc/generic-oidc.go +++ b/pkg/cmd/account/generic-oidc/generic-oidc.go @@ -14,7 +14,7 @@ func NewCmdGenericOidc(f factory.Factory) *cobra.Command { Use: "generic-oidc ", Short: "Manage Generic OpenID Connect accounts", Long: "Manage Generic OpenID Connect accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account generic-oidc list", constants.ExecutableName), + Example: heredoc.Docf("%s account generic-oidc list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/account/generic-oidc/list/list.go b/pkg/cmd/account/generic-oidc/list/list.go index 111d0452..d57c5d52 100644 --- a/pkg/cmd/account/generic-oidc/list/list.go +++ b/pkg/cmd/account/generic-oidc/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List Generic OpenID Connect accounts", Long: "List Generic OpenID Connect accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account generic-oidc list", constants.ExecutableName), + Example: heredoc.Docf("%s account generic-oidc list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/list/list.go b/pkg/cmd/account/list/list.go index 92c40bf3..7a8963f0 100644 --- a/pkg/cmd/account/list/list.go +++ b/pkg/cmd/account/list/list.go @@ -15,7 +15,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List accounts", Long: "List accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account list", constants.ExecutableName), + Example: heredoc.Docf("%s account list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, _ []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/ssh/create/create.go b/pkg/cmd/account/ssh/create/create.go index 44fd976c..6d633cb6 100644 --- a/pkg/cmd/account/ssh/create/create.go +++ b/pkg/cmd/account/ssh/create/create.go @@ -3,9 +3,10 @@ package create import ( b64 "encoding/base64" "fmt" - "github.com/OctopusDeploy/cli/pkg/cmd" "os" + "github.com/OctopusDeploy/cli/pkg/cmd" + "github.com/OctopusDeploy/cli/pkg/util" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" @@ -69,7 +70,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a SSH Key Pair account", Long: "Create a SSH Key Pair account in Octopus Deploy", - Example: heredoc.Docf("$ %s account ssh create", constants.ExecutableName), + Example: heredoc.Docf("%s account ssh create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/ssh/list/list.go b/pkg/cmd/account/ssh/list/list.go index 202412f1..283a178f 100644 --- a/pkg/cmd/account/ssh/list/list.go +++ b/pkg/cmd/account/ssh/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List SSH Key Pair accounts", Long: "List SSH Key Pair accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account ssh list", constants.ExecutableName), + Example: heredoc.Docf("%s account ssh list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, _ []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/ssh/ssh.go b/pkg/cmd/account/ssh/ssh.go index ed0efd57..0f9376c8 100644 --- a/pkg/cmd/account/ssh/ssh.go +++ b/pkg/cmd/account/ssh/ssh.go @@ -14,7 +14,7 @@ func NewCmdSsh(f factory.Factory) *cobra.Command { Use: "ssh ", Short: "Manage SSH Key Pair accounts", Long: "Manage SSH Key Pair accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account ssh list", constants.ExecutableName), + Example: heredoc.Docf("%s account ssh list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/account/token/create/create.go b/pkg/cmd/account/token/create/create.go index 217480a2..d18d7b1b 100644 --- a/pkg/cmd/account/token/create/create.go +++ b/pkg/cmd/account/token/create/create.go @@ -2,9 +2,10 @@ package create import ( "fmt" - "github.com/OctopusDeploy/cli/pkg/cmd" "os" + "github.com/OctopusDeploy/cli/pkg/cmd" + "github.com/OctopusDeploy/cli/pkg/util" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" @@ -63,7 +64,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a Token account", Long: "Create a Token account in Octopus Deploy", - Example: heredoc.Docf("$ %s account token create", constants.ExecutableName), + Example: heredoc.Docf("%s account token create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/token/list/list.go b/pkg/cmd/account/token/list/list.go index 7049578c..69830e27 100644 --- a/pkg/cmd/account/token/list/list.go +++ b/pkg/cmd/account/token/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List Token accounts", Long: "List Token accounts in Octopus Deploy", - Example: heredoc.Docf("$ %s account token list", constants.ExecutableName), + Example: heredoc.Docf("%s account token list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, _ []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/account/token/token.go b/pkg/cmd/account/token/token.go index 0b8835f5..9b681617 100644 --- a/pkg/cmd/account/token/token.go +++ b/pkg/cmd/account/token/token.go @@ -15,7 +15,7 @@ func NewCmdToken(f factory.Factory) *cobra.Command { Use: "token ", Short: "Manage Token accounts", Long: "Manage Token accounts in Octopus Deploy", - Example: fmt.Sprintf("$ %s account token list", constants.ExecutableName), + Example: fmt.Sprintf("%s account token list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/account/username/create/create.go b/pkg/cmd/account/username/create/create.go index 95a71118..f20bbfd2 100644 --- a/pkg/cmd/account/username/create/create.go +++ b/pkg/cmd/account/username/create/create.go @@ -2,9 +2,10 @@ package create import ( "fmt" - "github.com/OctopusDeploy/cli/pkg/cmd" "os" + "github.com/OctopusDeploy/cli/pkg/cmd" + "github.com/OctopusDeploy/cli/pkg/util" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" @@ -66,7 +67,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create a Username/Password account", Long: "Create a Username/Password account in Octopus Deploy", Example: heredoc.Docf(` - $ %s account username create" + %s account username create" `, constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/account/username/list/list.go b/pkg/cmd/account/username/list/list.go index a863de2f..a8d0e508 100644 --- a/pkg/cmd/account/username/list/list.go +++ b/pkg/cmd/account/username/list/list.go @@ -17,7 +17,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List Username/Password accounts", Long: "List Username/Password accounts in Octopus Deploy", Example: heredoc.Docf(` - $ %s account username list" + %s account username list" `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, _ []string) error { diff --git a/pkg/cmd/account/username/username.go b/pkg/cmd/account/username/username.go index 3e674273..afca657b 100644 --- a/pkg/cmd/account/username/username.go +++ b/pkg/cmd/account/username/username.go @@ -15,7 +15,7 @@ func NewCmdUsername(f factory.Factory) *cobra.Command { Use: "username ", Short: "Manage Username/Password accounts", Long: "Manage Username/Password accounts in Octopus Deploy", - Example: fmt.Sprintf("$ %s account username list", constants.ExecutableName), + Example: fmt.Sprintf("%s account username list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/api/api.go b/pkg/cmd/api/api.go index a020cc5f..4b0e0dca 100644 --- a/pkg/cmd/api/api.go +++ b/pkg/cmd/api/api.go @@ -23,9 +23,9 @@ func NewCmdAPI(f factory.Factory) *cobra.Command { Short: "Execute a raw API GET request", Long: "Execute an authenticated GET request against the Octopus Server API and print the JSON response.", Example: heredoc.Docf(` - $ %[1]s api /api - $ %[1]s api /api/spaces - $ %[1]s api /api/Spaces-1/projects + %[1]s api /api + %[1]s api /api/spaces + %[1]s api /api/Spaces-1/projects `, constants.ExecutableName), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/buildinformation/build-information.go b/pkg/cmd/buildinformation/build-information.go index 50b6c8d4..15f35680 100644 --- a/pkg/cmd/buildinformation/build-information.go +++ b/pkg/cmd/buildinformation/build-information.go @@ -19,7 +19,7 @@ func NewCmdBuildInformation(f factory.Factory) *cobra.Command { Use: "build-information ", Short: "Manage build information", Long: "Manage build information in Octopus Deploy", - Example: fmt.Sprintf("$ %s build-information upload", constants.ExecutableName), + Example: fmt.Sprintf("%s build-information upload", constants.ExecutableName), Aliases: []string{"build-info"}, Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/buildinformation/bulkdelete/bulk-delete.go b/pkg/cmd/buildinformation/bulkdelete/bulk-delete.go index 4d85d183..2f52a12d 100644 --- a/pkg/cmd/buildinformation/bulkdelete/bulk-delete.go +++ b/pkg/cmd/buildinformation/bulkdelete/bulk-delete.go @@ -57,9 +57,9 @@ func NewCmdBulkDelete(f factory.Factory) *cobra.Command { Short: "Bulk delete build information", Long: "Bulk delete build information in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s build-information bulk-delete - $ %[1]s build-info --package-id ThePackage - $ %[1]s build-info --package-id ThePackage --version 1.0.0 --version 1.0.1 + %[1]s build-information bulk-delete + %[1]s build-info --package-id ThePackage + %[1]s build-info --package-id ThePackage --version 1.0.0 --version 1.0.1 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewDeleteOptions(deleteFlags, cmd.NewDependencies(f, c), confirmFlags) diff --git a/pkg/cmd/buildinformation/delete/delete.go b/pkg/cmd/buildinformation/delete/delete.go index 083632c0..27f7b893 100644 --- a/pkg/cmd/buildinformation/delete/delete.go +++ b/pkg/cmd/buildinformation/delete/delete.go @@ -56,9 +56,9 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a build information in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s build-information delete BuildInformation-1 - $ %[1]s build-info rm BuildInformation-1 - $ %[1]s build-info del --package-id ThePackage --version 1.2.3 + %[1]s build-information delete BuildInformation-1 + %[1]s build-info rm BuildInformation-1 + %[1]s build-info del --package-id ThePackage --version 1.2.3 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { diff --git a/pkg/cmd/buildinformation/list/list.go b/pkg/cmd/buildinformation/list/list.go index ac8c025a..fe29cc19 100644 --- a/pkg/cmd/buildinformation/list/list.go +++ b/pkg/cmd/buildinformation/list/list.go @@ -44,11 +44,11 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List build information", Long: "List build information in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s build-information list - $ %[1]s build-information ls - $ %[1]s build-info list - $ %[1]s build-info ls --package-id ThePackage - $ %[1]s build-info ls --package-id ThePackage --filter 1.2.3 + %[1]s build-information list + %[1]s build-information ls + %[1]s build-info list + %[1]s build-info ls --package-id ThePackage + %[1]s build-info ls --package-id ThePackage --filter 1.2.3 `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/buildinformation/upload/upload.go b/pkg/cmd/buildinformation/upload/upload.go index a348a202..0fa17b74 100644 --- a/pkg/cmd/buildinformation/upload/upload.go +++ b/pkg/cmd/buildinformation/upload/upload.go @@ -66,10 +66,10 @@ func NewCmdUpload(f factory.Factory) *cobra.Command { Long: "upload build information one or more packages to Octopus Deploy.", Aliases: []string{"push"}, Example: heredoc.Docf(` - $ %[1]s build-information upload --package-id SomePackage --version 1.0.0 --file buildinfo.octopus - $ %[1]s build-information upload SomePackage --version 1.0.0 --file buildinfo.octopus --overwrite-mode overwrite - $ %[1]s build-information push SomePackage --version 1.0.0 --file buildinfo.octopus - $ %[1]s build-information upload PkgA PkgB PkgC --version 1.0.0 --file buildinfo.octopus + %[1]s build-information upload --package-id SomePackage --version 1.0.0 --file buildinfo.octopus + %[1]s build-information upload SomePackage --version 1.0.0 --file buildinfo.octopus --overwrite-mode overwrite + %[1]s build-information push SomePackage --version 1.0.0 --file buildinfo.octopus + %[1]s build-information upload PkgA PkgB PkgC --version 1.0.0 --file buildinfo.octopus `, constants.ExecutableName), Annotations: map[string]string{annotations.IsCore: "true"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/buildinformation/view/view.go b/pkg/cmd/buildinformation/view/view.go index 95a397be..23abd7b6 100644 --- a/pkg/cmd/buildinformation/view/view.go +++ b/pkg/cmd/buildinformation/view/view.go @@ -54,8 +54,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a build information", Long: "View a build information in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s build-information view BuildInformation-1 - $ %[1]s build-info view BuildInformation-1 + %[1]s build-information view BuildInformation-1 + %[1]s build-info view BuildInformation-1 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewViewOptions(viewFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/channel/channel.go b/pkg/cmd/channel/channel.go index 79d69dc5..04fa15a3 100644 --- a/pkg/cmd/channel/channel.go +++ b/pkg/cmd/channel/channel.go @@ -15,7 +15,7 @@ func NewCmdChannel(f factory.Factory) *cobra.Command { Short: "Manage channels", Long: "Manage channels in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s channel create + %[1]s channel create `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/channel/create/create.go b/pkg/cmd/channel/create/create.go index ce52c194..d9d6e1d5 100644 --- a/pkg/cmd/channel/create/create.go +++ b/pkg/cmd/channel/create/create.go @@ -63,8 +63,8 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create a channel", Long: "Create a channel in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s channel create - $ %[1]s channel create --name "The Channel" --project "The Project" --lifecycle "Default Lifecycle" --default + %[1]s channel create + %[1]s channel create --name "The Channel" --project "The Project" --lifecycle "Default Lifecycle" --default `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/config/get/get.go b/pkg/cmd/config/get/get.go index 7be30257..e76b11b0 100644 --- a/pkg/cmd/config/get/get.go +++ b/pkg/cmd/config/get/get.go @@ -17,6 +17,7 @@ func NewCmdGet(f factory.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "get [key]", Short: "Gets the value of config key for Octopus CLI", + Long: "Gets the value of config key for Octopus CLI.", RunE: func(cmd *cobra.Command, args []string) error { key := "" if len(args) > 0 { diff --git a/pkg/cmd/config/list/list.go b/pkg/cmd/config/list/list.go index 164b62d5..51a1d630 100644 --- a/pkg/cmd/config/list/list.go +++ b/pkg/cmd/config/list/list.go @@ -19,7 +19,7 @@ func NewCmdList(_ factory.Factory) *cobra.Command { Short: "List values from config file", Long: "List values from config file.", Example: heredoc.Docf(` - $ %s config list" + %s config list" `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/config/set/set.go b/pkg/cmd/config/set/set.go index 80b93abf..e27381af 100644 --- a/pkg/cmd/config/set/set.go +++ b/pkg/cmd/config/set/set.go @@ -18,6 +18,7 @@ func NewCmdSet(f factory.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "set [key] [value]", Short: "Set will write the value for given key to Octopus CLI config file", + Long: "Set will write the value for given key to Octopus CLI config file.", RunE: func(_ *cobra.Command, args []string) error { key := "" value := "" diff --git a/pkg/cmd/environment/create/create.go b/pkg/cmd/environment/create/create.go index 6f8f0b14..922affda 100644 --- a/pkg/cmd/environment/create/create.go +++ b/pkg/cmd/environment/create/create.go @@ -2,6 +2,7 @@ package create import ( "fmt" + "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" @@ -66,7 +67,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an environment", Long: "Create a environment in Octopus Deploy", - Example: heredoc.Docf("$ %s environment create", constants.ExecutableName), + Example: heredoc.Docf("%s environment create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/environment/delete/delete.go b/pkg/cmd/environment/delete/delete.go index 7ed76eae..e3ffa8fc 100644 --- a/pkg/cmd/environment/delete/delete.go +++ b/pkg/cmd/environment/delete/delete.go @@ -2,6 +2,7 @@ package delete import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/constants" @@ -21,8 +22,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete an environment in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s environment delete - $ %[1]s environment rm + %[1]s environment delete + %[1]s environment rm `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { if len(args) == 0 { diff --git a/pkg/cmd/environment/environment.go b/pkg/cmd/environment/environment.go index 9978ef4f..20d72dd2 100644 --- a/pkg/cmd/environment/environment.go +++ b/pkg/cmd/environment/environment.go @@ -18,8 +18,8 @@ func NewCmdEnvironment(f factory.Factory) *cobra.Command { Short: "Manage environments", Long: "Manage environments in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s environment list - $ %[1]s environment ls + %[1]s environment list + %[1]s environment ls `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsInfrastructure: "true", diff --git a/pkg/cmd/environment/list/list.go b/pkg/cmd/environment/list/list.go index bd8f1aad..670c49a4 100644 --- a/pkg/cmd/environment/list/list.go +++ b/pkg/cmd/environment/list/list.go @@ -1,9 +1,10 @@ package list import ( - "github.com/OctopusDeploy/cli/pkg/apiclient" "strconv" + "github.com/OctopusDeploy/cli/pkg/apiclient" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/constants" "github.com/OctopusDeploy/cli/pkg/factory" @@ -18,8 +19,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List environments", Long: "List environments in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s environment list - $ %[1]s environment ls" + %[1]s environment list + %[1]s environment ls" `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/environment/tag/tag.go b/pkg/cmd/environment/tag/tag.go index c6c9595a..f0ce0291 100644 --- a/pkg/cmd/environment/tag/tag.go +++ b/pkg/cmd/environment/tag/tag.go @@ -40,7 +40,7 @@ func NewCmdTag(f factory.Factory) *cobra.Command { Use: "tag", Short: "Override tags for an environment", Long: "Override tags for an environment in Octopus Deploy", - Example: heredoc.Docf("$ %s environment tag Environment-1", constants.ExecutableName), + Example: heredoc.Docf("%s environment tag Environment-1", constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewTagOptions(createFlags, cmd.NewDependencies(f, c)) @@ -146,4 +146,3 @@ func AskEnvironments(ask question.Asker, out io.Writer, value string, getEnviron return environment, nil } - diff --git a/pkg/cmd/ephemeralenvironment/create/create.go b/pkg/cmd/ephemeralenvironment/create/create.go index d2e46998..fb9762fe 100644 --- a/pkg/cmd/ephemeralenvironment/create/create.go +++ b/pkg/cmd/ephemeralenvironment/create/create.go @@ -87,7 +87,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an ephemeral environment", Long: "Create an ephemeral environment in Octopus Deploy", - Example: heredoc.Docf("$ %s ephemeral-environment create", constants.ExecutableName), + Example: heredoc.Docf("%s ephemeral-environment create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/ephemeralenvironment/deprovision-environment/deprovision_environment.go b/pkg/cmd/ephemeralenvironment/deprovision-environment/deprovision_environment.go index bb5f13ae..bc09d47b 100644 --- a/pkg/cmd/ephemeralenvironment/deprovision-environment/deprovision_environment.go +++ b/pkg/cmd/ephemeralenvironment/deprovision-environment/deprovision_environment.go @@ -63,7 +63,7 @@ func NewCmdDeprovisionEnvironment(factory factory.Factory) *cobra.Command { Use: "deprovision-environment", Short: "Deprovision an environment", Long: "Deprovision an environment", - Example: heredoc.Docf("$ %s ephemeral-environment deprovision-environment --name PR-1234", constants.ExecutableName), + Example: heredoc.Docf("%s ephemeral-environment deprovision-environment --name PR-1234", constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { deprovisionEnvironmentOptions := NewDeprovisionEnvironmentOptions(deprovisionEnvironmentFlags, cmd.NewDependencies(factory, c), c) diff --git a/pkg/cmd/ephemeralenvironment/deprovision-project/deprovision_project.go b/pkg/cmd/ephemeralenvironment/deprovision-project/deprovision_project.go index 2d918212..74555a49 100644 --- a/pkg/cmd/ephemeralenvironment/deprovision-project/deprovision_project.go +++ b/pkg/cmd/ephemeralenvironment/deprovision-project/deprovision_project.go @@ -105,7 +105,7 @@ func NewCmdDeprovisionProject(f factory.Factory) *cobra.Command { Use: "deprovision-project", Short: "Deprovision an ephemeral environment for a project", Long: "Deprovision an ephemeral environment in Octopus Deploy for a specific project", - Example: heredoc.Docf("$ %s ephemeral-environment deprovision-project", constants.ExecutableName), + Example: heredoc.Docf("%s ephemeral-environment deprovision-project", constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewDeprovisionProjectOptions(createFlags, cmd.NewDependencies(f, c), c) diff --git a/pkg/cmd/ephemeralenvironment/ephemeralenvironment.go b/pkg/cmd/ephemeralenvironment/ephemeralenvironment.go index 3e32140e..f8e77ae9 100644 --- a/pkg/cmd/ephemeralenvironment/ephemeralenvironment.go +++ b/pkg/cmd/ephemeralenvironment/ephemeralenvironment.go @@ -17,7 +17,7 @@ func NewCmdEphemeralEnvironment(f factory.Factory) *cobra.Command { Short: "Manage ephemeral environments", Long: "Manage ephemeral environments in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s ephemeral-environment create --name "MyEphemeralEnvironment" --project "MyProject" + %[1]s ephemeral-environment create --name "MyEphemeralEnvironment" --project "MyProject" `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsInfrastructure: "true", diff --git a/pkg/cmd/login/login.go b/pkg/cmd/login/login.go index 5844a1d7..d6ed863d 100644 --- a/pkg/cmd/login/login.go +++ b/pkg/cmd/login/login.go @@ -6,11 +6,12 @@ import ( "encoding/json" "errors" "fmt" - "github.com/AlecAivazis/survey/v2" "io" "net/http" "time" + "github.com/AlecAivazis/survey/v2" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/config" @@ -60,9 +61,9 @@ func NewCmdLogin(f factory.Factory) *cobra.Command { Short: "Login to Octopus", Long: "Login to your Octopus server using OpenID Connect (OIDC) or an API key. If no arguments are provided then login will be done interactively allowing creation of an API key.", Example: heredoc.Docf(` - $ %[1]s login - $ %[1]s login --server https://my.octopus.app --service-account-id b1a6f20f-0ec7-4e9a-938e-db800f945b37 --id-token eyJhbGciOiJQUzI1NiIs... - $ %[1]s login --server https://my.octopus.app --api-key API-APIKEY123 + %[1]s login + %[1]s login --server https://my.octopus.app --service-account-id b1a6f20f-0ec7-4e9a-938e-db800f945b37 --id-token eyJhbGciOiJQUzI1NiIs... + %[1]s login --server https://my.octopus.app --api-key API-APIKEY123 `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { return loginRun(cmd, f, f.IsPromptEnabled(), f.Ask, loginFlags) diff --git a/pkg/cmd/package/delete/delete.go b/pkg/cmd/package/delete/delete.go index 1e1acada..ef9ccdc3 100644 --- a/pkg/cmd/package/delete/delete.go +++ b/pkg/cmd/package/delete/delete.go @@ -59,9 +59,9 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a package in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s package delete Packages-1 - $ %[1]s package rm Packages-1 - $ %[1]s package del --package-id ThePackage --version 1.0.0 + %[1]s package delete Packages-1 + %[1]s package rm Packages-1 + %[1]s package del --package-id ThePackage --version 1.0.0 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { diff --git a/pkg/cmd/package/list/list.go b/pkg/cmd/package/list/list.go index a937dd99..708da65c 100644 --- a/pkg/cmd/package/list/list.go +++ b/pkg/cmd/package/list/list.go @@ -1,9 +1,10 @@ package list import ( - "github.com/OctopusDeploy/cli/pkg/apiclient" "math" + "github.com/OctopusDeploy/cli/pkg/apiclient" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/constants" "github.com/OctopusDeploy/cli/pkg/factory" @@ -38,9 +39,9 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List packages", Long: "List packages in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s package list - $ %[1]s package list --limit 50 --filter SomePackage - $ %[1]s package ls -n 30 -q SomePackage + %[1]s package list + %[1]s package list --limit 50 --filter SomePackage + %[1]s package ls -n 30 -q SomePackage `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/package/nuget/create/create.go b/pkg/cmd/package/nuget/create/create.go index 1b110807..158ae317 100644 --- a/pkg/cmd/package/nuget/create/create.go +++ b/pkg/cmd/package/nuget/create/create.go @@ -59,7 +59,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create nuget", Long: "Create nuget package", Example: heredoc.Docf(` - $ %[1]s package nuget create --id SomePackage --version 1.0.0 + %[1]s package nuget create --id SomePackage --version 1.0.0 `, constants.ExecutableName), RunE: func(cmd *cobra.Command, _ []string) error { opts := &NuPkgCreateOptions{ diff --git a/pkg/cmd/package/nuget/nuget.go b/pkg/cmd/package/nuget/nuget.go index 8827517b..b295c34b 100644 --- a/pkg/cmd/package/nuget/nuget.go +++ b/pkg/cmd/package/nuget/nuget.go @@ -13,7 +13,7 @@ func NewCmdPackageNuget(f factory.Factory) *cobra.Command { Use: "nuget ", Short: "Package as NuPkg", Long: "Package as NuPkg for Octopus Deploy", - Example: heredoc.Docf("$ %s package nuget create", constants.ExecutableName), + Example: heredoc.Docf("%s package nuget create", constants.ExecutableName), } cmd.AddCommand(cmdNugetCreate.NewCmdCreate(f)) diff --git a/pkg/cmd/package/package.go b/pkg/cmd/package/package.go index 6eb1a896..45c7c966 100644 --- a/pkg/cmd/package/package.go +++ b/pkg/cmd/package/package.go @@ -20,7 +20,7 @@ func NewCmdPackage(f factory.Factory) *cobra.Command { Use: "package ", Short: "Manage packages", Long: "Manage packages in Octopus Deploy", - Example: fmt.Sprintf("$ %s package upload", constants.ExecutableName), + Example: fmt.Sprintf("%s package upload", constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", }, diff --git a/pkg/cmd/package/upload/upload.go b/pkg/cmd/package/upload/upload.go index 9fd8c69e..48dc32aa 100644 --- a/pkg/cmd/package/upload/upload.go +++ b/pkg/cmd/package/upload/upload.go @@ -4,12 +4,13 @@ import ( "encoding/json" "errors" "fmt" - "github.com/OctopusDeploy/cli/pkg/apiclient" "io" "os" "path/filepath" "strings" + "github.com/OctopusDeploy/cli/pkg/apiclient" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/constants" "github.com/OctopusDeploy/cli/pkg/constants/annotations" @@ -61,13 +62,13 @@ func NewCmdUpload(f factory.Factory) *cobra.Command { Long: "Upload one or more packages to Octopus Deploy. Glob patterns are supported. Delta compression is off by default.", Aliases: []string{"push"}, Example: heredoc.Docf(` - $ %[1]s package upload --package SomePackage.1.0.0.zip - $ %[1]s package upload SomePackage.1.0.0.tar.gz --overwrite-mode overwrite - $ %[1]s package push SomePackage.1.0.0.zip - $ %[1]s package upload bin/**/*.zip --continue-on-error - $ %[1]s package upload PkgA.1.0.0.zip PkgB.2.0.0.tar.gz PkgC.1.0.0.nupkg - $ %[1]s package upload --package SomePackage.2.0.0.zip --use-delta-compression - $ %[1]s package upload SomePackage.2.0.0.zip --delta # alias for --use-delta-compression + %[1]s package upload --package SomePackage.1.0.0.zip + %[1]s package upload SomePackage.1.0.0.tar.gz --overwrite-mode overwrite + %[1]s package push SomePackage.1.0.0.zip + %[1]s package upload bin/**/*.zip --continue-on-error + %[1]s package upload PkgA.1.0.0.zip PkgB.2.0.0.tar.gz PkgC.1.0.0.nupkg + %[1]s package upload --package SomePackage.2.0.0.zip --use-delta-compression + %[1]s package upload SomePackage.2.0.0.zip --delta # alias for --use-delta-compression `, constants.ExecutableName), Annotations: map[string]string{annotations.IsCore: "true"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/package/versions/versions.go b/pkg/cmd/package/versions/versions.go index 6d0e1f84..8fc4d363 100644 --- a/pkg/cmd/package/versions/versions.go +++ b/pkg/cmd/package/versions/versions.go @@ -3,11 +3,12 @@ package versions import ( "errors" "fmt" - "github.com/OctopusDeploy/cli/pkg/apiclient" - "github.com/OctopusDeploy/cli/pkg/util" "math" "time" + "github.com/OctopusDeploy/cli/pkg/apiclient" + "github.com/OctopusDeploy/cli/pkg/util" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/constants" "github.com/OctopusDeploy/cli/pkg/factory" @@ -47,9 +48,9 @@ func NewCmdVersions(f factory.Factory) *cobra.Command { Short: "List versions of a package", Long: "List versions of a package.", Example: heredoc.Docf(` - $ %[1]s package versions --package SomePackage - $ %[1]s package versions SomePackage --filter beta --limit 5 - $ %[1]s package show SomePackage -n 2 + %[1]s package versions --package SomePackage + %[1]s package versions SomePackage --filter beta --limit 5 + %[1]s package show SomePackage -n 2 `, constants.ExecutableName), Aliases: []string{"show"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/package/zip/create/create.go b/pkg/cmd/package/zip/create/create.go index 5441b115..e4a75d11 100644 --- a/pkg/cmd/package/zip/create/create.go +++ b/pkg/cmd/package/zip/create/create.go @@ -21,7 +21,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create zip", Long: "Create zip package", Example: heredoc.Docf(` - $ %[1]s package zip create --id SomePackage --version 1.0.0 + %[1]s package zip create --id SomePackage --version 1.0.0 `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { opts := pack.NewPackageCreateOptions(f, createFlags, cmd) diff --git a/pkg/cmd/package/zip/zip.go b/pkg/cmd/package/zip/zip.go index c55e20e7..91619fea 100644 --- a/pkg/cmd/package/zip/zip.go +++ b/pkg/cmd/package/zip/zip.go @@ -13,7 +13,7 @@ func NewCmdPackageZip(f factory.Factory) *cobra.Command { Use: "zip ", Short: "Package as zip", Long: "Package as zip for Octopus Deploy", - Example: heredoc.Docf("$ %s package zip create", constants.ExecutableName), + Example: heredoc.Docf("%s package zip create", constants.ExecutableName), } cmd.AddCommand(cmdZipCreate.NewCmdCreate(f)) diff --git a/pkg/cmd/project/branch/branch.go b/pkg/cmd/project/branch/branch.go index 3bf01ca4..87e61abe 100644 --- a/pkg/cmd/project/branch/branch.go +++ b/pkg/cmd/project/branch/branch.go @@ -17,8 +17,8 @@ func NewCmdBranch(f factory.Factory) *cobra.Command { Short: "Manage project branches", Long: "Manage project branches in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project branch list "Deploy Web App" - $ %[1]s project branch create -p "Deploy Web App" --new-branch-name add-name-variable --base-branch refs/heads/main - + %[1]s project branch list "Deploy Web App" + %[1]s project branch create -p "Deploy Web App" --new-branch-name add-name-variable --base-branch refs/heads/main - `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/project/branch/create/create.go b/pkg/cmd/project/branch/create/create.go index 48befc40..f53175a5 100644 --- a/pkg/cmd/project/branch/create/create.go +++ b/pkg/cmd/project/branch/create/create.go @@ -65,8 +65,8 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Long: "Create a Git branch for a project in Octopus Deploy", Aliases: []string{"add"}, Example: heredoc.Docf(` - $ %[1]s project branch create - $ %[1]s project branch create --project "Deploy Website" --name branch-name --base-branch refs/heads/main + %[1]s project branch create + %[1]s project branch create --project "Deploy Website" --name branch-name --base-branch refs/heads/main `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/branch/list/list.go b/pkg/cmd/project/branch/list/list.go index bb35f73b..6f989a77 100644 --- a/pkg/cmd/project/branch/list/list.go +++ b/pkg/cmd/project/branch/list/list.go @@ -2,6 +2,8 @@ package list import ( "fmt" + "strconv" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" sharedBranches "github.com/OctopusDeploy/cli/pkg/cmd/project/branch/shared" @@ -13,7 +15,6 @@ import ( "github.com/OctopusDeploy/cli/pkg/util/flag" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projects" "github.com/spf13/cobra" - "strconv" ) const ( @@ -65,8 +66,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List project branches", Long: "List project branches in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project branch list "Deploy Website" - $ %[1]s project variable ls + %[1]s project branch list "Deploy Website" + %[1]s project variable ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/project/clone/clone.go b/pkg/cmd/project/clone/clone.go index 7db977b3..54e28eb4 100644 --- a/pkg/cmd/project/clone/clone.go +++ b/pkg/cmd/project/clone/clone.go @@ -2,6 +2,7 @@ package clone import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" projectShared "github.com/OctopusDeploy/cli/pkg/cmd/project/shared" @@ -70,9 +71,9 @@ func NewCmdClone(f factory.Factory) *cobra.Command { Short: "Clone a project", Long: "Clone a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project clone - $ %[1]s project clone --name 'New Project' --source 'Old Project' - $ %[1]s project clone --name 'Deploy web app 2' --source 'Deploy web app' --lifecycle 'Test Only Lifecycle' --group 'Web App Project Group' + %[1]s project clone + %[1]s project clone --name 'New Project' --source 'Old Project' + %[1]s project clone --name 'Deploy web app 2' --source 'Deploy web app' --lifecycle 'Test Only Lifecycle' --group 'Web App Project Group' `, constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewCloneOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/connect/connect.go b/pkg/cmd/project/connect/connect.go index b2bb8c84..21217bcd 100644 --- a/pkg/cmd/project/connect/connect.go +++ b/pkg/cmd/project/connect/connect.go @@ -16,8 +16,8 @@ func NewCmdConnect(f factory.Factory) *cobra.Command { Short: "Connect a tenant to a project", Long: "Connect a tenant to a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project connect - $ %[1]s project connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" + %[1]s project connect + %[1]s project connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := connectTenant.NewConnectOptions(connectFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/convert/convert.go b/pkg/cmd/project/convert/convert.go index 08382290..4032d68a 100644 --- a/pkg/cmd/project/convert/convert.go +++ b/pkg/cmd/project/convert/convert.go @@ -2,6 +2,9 @@ package convert import ( "fmt" + "net/url" + "strings" + "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" @@ -19,8 +22,6 @@ import ( "github.com/spf13/cobra" "github.com/spf13/pflag" "golang.org/x/exp/slices" - "net/url" - "strings" ) const ( @@ -108,8 +109,8 @@ func NewCmdConvert(f factory.Factory) *cobra.Command { Short: "Convert a project to use Config As Code", Long: "Convert a project to use Config As Code in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project convert - $ %[1]s project convert --project "Deploy web site" --git-url https://github.com/orgname/reponame" + %[1]s project convert + %[1]s project convert --project "Deploy web site" --git-url https://github.com/orgname/reponame" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewConvertOptions(convertProjectFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/create/create.go b/pkg/cmd/project/create/create.go index 027ecadd..a216dd53 100644 --- a/pkg/cmd/project/create/create.go +++ b/pkg/cmd/project/create/create.go @@ -2,6 +2,7 @@ package create import ( "fmt" + "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" @@ -55,9 +56,9 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create a project", Long: "Create a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project create - $ %[1]s project create --process-vcs - $ %[1]s project create --name 'Deploy web app' --lifecycle 'Default Lifecycle' --group 'Default Project Group' + %[1]s project create + %[1]s project create --process-vcs + %[1]s project create --name 'Deploy web app' --lifecycle 'Default Lifecycle' --group 'Default Project Group' `, constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/delete/delete.go b/pkg/cmd/project/delete/delete.go index f749d8c0..84d590a1 100644 --- a/pkg/cmd/project/delete/delete.go +++ b/pkg/cmd/project/delete/delete.go @@ -2,6 +2,7 @@ package delete import ( "fmt" + "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/MakeNowJust/heredoc/v2" @@ -30,8 +31,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Long: "Delete a project in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s project delete - $ %[1]s project rm + %[1]s project delete + %[1]s project rm `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/project/disable/disable.go b/pkg/cmd/project/disable/disable.go index 557e1c11..36e9fd98 100644 --- a/pkg/cmd/project/disable/disable.go +++ b/pkg/cmd/project/disable/disable.go @@ -29,7 +29,7 @@ func NewCmdDisable(f factory.Factory) *cobra.Command { Use: "disable", Short: "Disable a project", Long: "Disable a project in Octopus Deploy", - Example: heredoc.Docf("$ %[1]s project disable", constants.ExecutableName), + Example: heredoc.Docf("%[1]s project disable", constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { args = append(args, "") diff --git a/pkg/cmd/project/disconnect/disconnect.go b/pkg/cmd/project/disconnect/disconnect.go index 73338dec..ddadda3d 100644 --- a/pkg/cmd/project/disconnect/disconnect.go +++ b/pkg/cmd/project/disconnect/disconnect.go @@ -17,8 +17,8 @@ func NewCmdDisconnect(f factory.Factory) *cobra.Command { Short: "Disconnect a tenant from a project", Long: "Disconnect a tenant from a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project disconnect - $ %[1]s project disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm + %[1]s project disconnect + %[1]s project disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := tenantDisconnect.NewDisconnectOptions(disconnectFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/enable/enable.go b/pkg/cmd/project/enable/enable.go index a8e9fd3e..2da6287b 100644 --- a/pkg/cmd/project/enable/enable.go +++ b/pkg/cmd/project/enable/enable.go @@ -29,7 +29,7 @@ func NewCmdEnable(f factory.Factory) *cobra.Command { Use: "enable", Short: "Enable a project", Long: "Enable a project in Octopus Deploy", - Example: heredoc.Docf("$ %[1]s project enable", constants.ExecutableName), + Example: heredoc.Docf("%[1]s project enable", constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { args = append(args, "") diff --git a/pkg/cmd/project/list/list.go b/pkg/cmd/project/list/list.go index ce40f92d..702e80ce 100644 --- a/pkg/cmd/project/list/list.go +++ b/pkg/cmd/project/list/list.go @@ -16,8 +16,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List projects", Long: "List projects in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project list - $ %[1]s project ls + %[1]s project list + %[1]s project ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/project/project.go b/pkg/cmd/project/project.go index bc825eb1..c55d1bad 100644 --- a/pkg/cmd/project/project.go +++ b/pkg/cmd/project/project.go @@ -28,8 +28,8 @@ func NewCmdProject(f factory.Factory) *cobra.Command { Short: "Manage projects", Long: "Manage projects in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project list - $ %[1]s project ls + %[1]s project list + %[1]s project ls `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/project/tag/tag.go b/pkg/cmd/project/tag/tag.go index a00700c5..bb558144 100644 --- a/pkg/cmd/project/tag/tag.go +++ b/pkg/cmd/project/tag/tag.go @@ -40,7 +40,7 @@ func NewCmdTag(f factory.Factory) *cobra.Command { Use: "tag", Short: "Override tags for a project", Long: "Override tags for a project in Octopus Deploy", - Example: heredoc.Docf("$ %s project tag Project-1", constants.ExecutableName), + Example: heredoc.Docf("%s project tag Project-1", constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewTagOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/variables/create/create.go b/pkg/cmd/project/variables/create/create.go index 00ef9a39..42d6bdf7 100644 --- a/pkg/cmd/project/variables/create/create.go +++ b/pkg/cmd/project/variables/create/create.go @@ -2,6 +2,8 @@ package create import ( "fmt" + "strings" + "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" @@ -18,7 +20,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/resources" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/variables" "github.com/spf13/cobra" - "strings" ) const ( @@ -114,11 +115,11 @@ func NewCreateCmd(f factory.Factory) *cobra.Command { Long: "Create a variable for a project in Octopus Deploy", Aliases: []string{"add"}, Example: heredoc.Docf(` - $ %[1]s project variable create - $ %[1]s project variable create --project "Deploy Website" --name "variable name" --value "abc" - $ %[1]s project variable create --name "variable name" --value "passwordABC" --type sensitive - $ %[1]s project variable create --name "variable name" --value "abc" --scope environment='test' - $ %[1]s project variable create --name "variable name" --value "abc" --scope environment='test' --git-ref refs/heads/main + %[1]s project variable create + %[1]s project variable create --project "Deploy Website" --name "variable name" --value "abc" + %[1]s project variable create --name "variable name" --value "passwordABC" --type sensitive + %[1]s project variable create --name "variable name" --value "abc" --scope environment='test' + %[1]s project variable create --name "variable name" --value "abc" --scope environment='test' --git-ref refs/heads/main `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/variables/delete/delete.go b/pkg/cmd/project/variables/delete/delete.go index 0f7823d8..f4ffb180 100644 --- a/pkg/cmd/project/variables/delete/delete.go +++ b/pkg/cmd/project/variables/delete/delete.go @@ -2,6 +2,8 @@ package delete import ( "fmt" + "strings" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/tenant/shared" @@ -14,7 +16,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projects" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/variables" "github.com/spf13/cobra" - "strings" ) const ( @@ -70,9 +71,9 @@ func NewDeleteCmd(f factory.Factory) *cobra.Command { Short: "Delete a project variable", Long: "Delete a project variable in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project variable delete --name "variable Name" --project "Deploy Site" - $ %[1]s project variable delete --name "variable Name" --id 26a58596-4cd9-e072-7215-7e15cb796dd2 --project "Deploy Site" --confirm - $ %[1]s project variable delete --name "variable Name" --project "Deploy Site" --git-ref "refs/heads/main" + %[1]s project variable delete --name "variable Name" --project "Deploy Site" + %[1]s project variable delete --name "variable Name" --id 26a58596-4cd9-e072-7215-7e15cb796dd2 --project "Deploy Site" --confirm + %[1]s project variable delete --name "variable Name" --project "Deploy Site" --git-ref "refs/heads/main" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewDeleteOptions(deleteFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/variables/exclude/exclude.go b/pkg/cmd/project/variables/exclude/exclude.go index ef898c47..96dce968 100644 --- a/pkg/cmd/project/variables/exclude/exclude.go +++ b/pkg/cmd/project/variables/exclude/exclude.go @@ -65,8 +65,8 @@ func NewExcludeVariableSetCmd(f factory.Factory) *cobra.Command { Short: "Exclude a variable set from a project", Long: "Exclude a variable set from a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project variable exclude - $ %[1]s project variable exclude --variable-set "Slack Variables" + %[1]s project variable exclude + %[1]s project variable exclude --variable-set "Slack Variables" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewExcludeOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/variables/include/include.go b/pkg/cmd/project/variables/include/include.go index faf8bf39..fdccb71b 100644 --- a/pkg/cmd/project/variables/include/include.go +++ b/pkg/cmd/project/variables/include/include.go @@ -65,8 +65,8 @@ func NewIncludeVariableSetCmd(f factory.Factory) *cobra.Command { Short: "Include a variable set in a project", Long: "Include a variable set in a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project variable include - $ %[1]s project variable include --variable-set "Slack Variables" + %[1]s project variable include + %[1]s project variable include --variable-set "Slack Variables" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewIncludeOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/variables/list/list.go b/pkg/cmd/project/variables/list/list.go index e51936ed..14a422c7 100644 --- a/pkg/cmd/project/variables/list/list.go +++ b/pkg/cmd/project/variables/list/list.go @@ -63,9 +63,9 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List project variables", Long: "List project variables in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project variable list "Deploy Website" - $ %[1]s project variable list -p "Deploy Website" --git-ref refs/heads/main - $ %[1]s project variable ls + %[1]s project variable list "Deploy Website" + %[1]s project variable list -p "Deploy Website" --git-ref refs/heads/main + %[1]s project variable ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/project/variables/update/update.go b/pkg/cmd/project/variables/update/update.go index c9d378d1..8321b05d 100644 --- a/pkg/cmd/project/variables/update/update.go +++ b/pkg/cmd/project/variables/update/update.go @@ -2,6 +2,8 @@ package update import ( "fmt" + "strings" + "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" @@ -18,7 +20,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projects" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/variables" "github.com/spf13/cobra" - "strings" ) const ( @@ -80,12 +81,12 @@ func NewUpdateCmd(f factory.Factory) *cobra.Command { Short: "Update the value of a project variable", Long: "Update the value of a project variable in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project variable update - $ %[1]s project variable update --name "variable name" --value "abc" - $ %[1]s project variable update --name "variable name" --value "password" - $ %[1]s project variable update --name "variable name" --unscoped - $ %[1]s project variable update --name "variable name" --environment-scope test - $ %[1]s project variable update -p "Deploy Website" --name "variable name" --value "updated" --git-ref refs/heads/main + %[1]s project variable update + %[1]s project variable update --name "variable name" --value "abc" + %[1]s project variable update --name "variable name" --value "password" + %[1]s project variable update --name "variable name" --unscoped + %[1]s project variable update --name "variable name" --environment-scope test + %[1]s project variable update -p "Deploy Website" --name "variable name" --value "updated" --git-ref refs/heads/main `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewUpdateOptions(updateFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/project/variables/variables.go b/pkg/cmd/project/variables/variables.go index 669c9d45..c5a4aa78 100644 --- a/pkg/cmd/project/variables/variables.go +++ b/pkg/cmd/project/variables/variables.go @@ -22,9 +22,9 @@ func NewCmdVariables(f factory.Factory) *cobra.Command { Short: "Manage project variables", Long: "Manage project variables in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project variable list "Deploy Web App" - $ %[1]s project variable view --name "DatabaseName" --project Deploy - $ %[1]s project variable update + %[1]s project variable list "Deploy Web App" + %[1]s project variable view --name "DatabaseName" --project Deploy + %[1]s project variable update `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/project/variables/view/view.go b/pkg/cmd/project/variables/view/view.go index 30518650..155e4302 100644 --- a/pkg/cmd/project/variables/view/view.go +++ b/pkg/cmd/project/variables/view/view.go @@ -59,8 +59,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View all values of a project variable", Long: "View all values of a project variable in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project variable view - $ %[1]s project variable view DatabaseName --project "Vet Clinic" + %[1]s project variable view + %[1]s project variable view DatabaseName --project "Vet Clinic" `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { @@ -158,14 +158,14 @@ func viewRun(opts *ViewOptions) error { } type VariableValueAsJson struct { - Id string `json:"Id"` - Name string `json:"Name"` - Value string `json:"Value"` - IsSensitive bool `json:"IsSensitive"` - Description string `json:"Description"` - Scope *variables.VariableScopeValues `json:"Scope"` - Prompt *variables.VariablePromptOptions `json:"Prompt,omitempty"` - WebUrl string `json:"WebUrl"` + Id string `json:"Id"` + Name string `json:"Name"` + Value string `json:"Value"` + IsSensitive bool `json:"IsSensitive"` + Description string `json:"Description"` + Scope *variables.VariableScopeValues `json:"Scope"` + Prompt *variables.VariablePromptOptions `json:"Prompt,omitempty"` + WebUrl string `json:"WebUrl"` } func getVariableValueAsJson(opts *ViewOptions, item *VariableValueWithScope) VariableValueAsJson { diff --git a/pkg/cmd/project/view/view.go b/pkg/cmd/project/view/view.go index b3e5dd3d..625d67b7 100644 --- a/pkg/cmd/project/view/view.go +++ b/pkg/cmd/project/view/view.go @@ -2,10 +2,11 @@ package view import ( "fmt" - "github.com/OctopusDeploy/cli/pkg/apiclient" "io" "strings" + "github.com/OctopusDeploy/cli/pkg/apiclient" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/constants" "github.com/OctopusDeploy/cli/pkg/factory" @@ -50,9 +51,9 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a project", Long: "View a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project view 'Deploy Web App' - $ %[1]s project view Projects-9000 - $ %[1]s project view deploy-web-app + %[1]s project view 'Deploy Web App' + %[1]s project view Projects-9000 + %[1]s project view deploy-web-app `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/projectgroup/create/create.go b/pkg/cmd/projectgroup/create/create.go index 8459e436..6a8a2fc8 100644 --- a/pkg/cmd/projectgroup/create/create.go +++ b/pkg/cmd/projectgroup/create/create.go @@ -74,7 +74,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a project group", Long: "Create a project group in Octopus Deploy", - Example: heredoc.Docf("$ %s project-group create", constants.ExecutableName), + Example: heredoc.Docf("%s project-group create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(optFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/projectgroup/delete/delete.go b/pkg/cmd/projectgroup/delete/delete.go index 5c2dc535..5abe74f0 100644 --- a/pkg/cmd/projectgroup/delete/delete.go +++ b/pkg/cmd/projectgroup/delete/delete.go @@ -28,8 +28,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Long: "Delete a project group in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s project-group delete - $ %[1]s project-group rm + %[1]s project-group delete + %[1]s project-group rm `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/projectgroup/list/list.go b/pkg/cmd/projectgroup/list/list.go index 3ada9ca7..31eeb05e 100644 --- a/pkg/cmd/projectgroup/list/list.go +++ b/pkg/cmd/projectgroup/list/list.go @@ -22,8 +22,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List project groups", Long: "List project groups in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project-group list - $ %[1]s project-group ls + %[1]s project-group list + %[1]s project-group ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/projectgroup/project-group.go b/pkg/cmd/projectgroup/project-group.go index 311d52ed..46555189 100644 --- a/pkg/cmd/projectgroup/project-group.go +++ b/pkg/cmd/projectgroup/project-group.go @@ -18,8 +18,8 @@ func NewCmdProjectGroup(f factory.Factory) *cobra.Command { Short: "Manage project groups", Long: "Manage project groups in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project-group list - $ %[1]s project-group ls + %[1]s project-group list + %[1]s project-group ls `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/projectgroup/view/view.go b/pkg/cmd/projectgroup/view/view.go index ab04684d..52ef9ebb 100644 --- a/pkg/cmd/projectgroup/view/view.go +++ b/pkg/cmd/projectgroup/view/view.go @@ -52,8 +52,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a project group", Long: "View a project group in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s project-group view 'Default Project Group' - $ %[1]s project-group view ProjectGroups-9000 + %[1]s project-group view 'Default Project Group' + %[1]s project-group view ProjectGroups-9000 `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/release/create/create.go b/pkg/cmd/release/create/create.go index 76d01def..9c79f4dc 100644 --- a/pkg/cmd/release/create/create.go +++ b/pkg/cmd/release/create/create.go @@ -155,10 +155,10 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create a release", Long: "Create a release in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s release create --project MyProject --channel Beta --version 1.2.3 - $ %[1]s release create -p MyProject -c Beta -v 1.2.3 - $ %[1]s release create -p MyProject -c default --package "utils:1.2.3" --package "utils:InstallOnly:5.6.7" - $ %[1]s release create -p MyProject -c Beta --no-prompt + %[1]s release create --project MyProject --channel Beta --version 1.2.3 + %[1]s release create -p MyProject -c Beta -v 1.2.3 + %[1]s release create -p MyProject -c default --package "utils:1.2.3" --package "utils:InstallOnly:5.6.7" + %[1]s release create -p MyProject -c Beta --no-prompt `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { return createRun(cmd, f, createFlags) }, } diff --git a/pkg/cmd/release/delete/delete.go b/pkg/cmd/release/delete/delete.go index 0987b02f..59b2fee2 100644 --- a/pkg/cmd/release/delete/delete.go +++ b/pkg/cmd/release/delete/delete.go @@ -46,9 +46,9 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Short: "Delete a release", Long: "Delete a release in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s release delete myProject 2.0 - $ %[1]s release delete --project myProject --version 2.0 - $ %[1]s release rm "Other Project" -v 2.0 + %[1]s release delete myProject 2.0 + %[1]s release delete --project myProject --version 2.0 + %[1]s release rm "Other Project" -v 2.0 `, constants.ExecutableName), Aliases: []string{"del", "rm"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/release/deploy/deploy.go b/pkg/cmd/release/deploy/deploy.go index 508e6a0e..7637a51a 100644 --- a/pkg/cmd/release/deploy/deploy.go +++ b/pkg/cmd/release/deploy/deploy.go @@ -142,11 +142,11 @@ func NewCmdDeploy(f factory.Factory) *cobra.Command { Short: "Deploy releases", Long: "Deploy releases in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s release deploy # fully interactive - $ %[1]s release deploy --project MyProject --version 1.0 --environment Dev - $ %[1]s release deploy --project MyProject --version 1.0 --tenant-tag Regions/East --tenant-tag Regions/South - $ %[1]s release deploy -p MyProject --version 1.0 -e Dev --skip InstallStep --variable VarName:VarValue - $ %[1]s release deploy -p MyProject --version 1.0 -e Dev --force-package-download --guided-failure true -f basic + %[1]s release deploy # fully interactive + %[1]s release deploy --project MyProject --version 1.0 --environment Dev + %[1]s release deploy --project MyProject --version 1.0 --tenant-tag Regions/East --tenant-tag Regions/South + %[1]s release deploy -p MyProject --version 1.0 -e Dev --skip InstallStep --variable VarName:VarValue + %[1]s release deploy -p MyProject --version 1.0 -e Dev --force-package-download --guided-failure true -f basic `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { if len(args) > 0 && deployFlags.Project.Value == "" { diff --git a/pkg/cmd/release/list/list.go b/pkg/cmd/release/list/list.go index e2bdfb17..ce0d8785 100644 --- a/pkg/cmd/release/list/list.go +++ b/pkg/cmd/release/list/list.go @@ -2,6 +2,8 @@ package list import ( "errors" + "time" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/constants" @@ -14,7 +16,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projects" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/releases" "github.com/spf13/cobra" - "time" ) const ( @@ -46,9 +47,9 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List releases", Long: "List releases in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s release list myProject - $ %[1]s release ls "Other Project" - $ %[1]s release list --project myProject + %[1]s release list myProject + %[1]s release ls "Other Project" + %[1]s release list --project myProject `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/release/progression/allow/allow.go b/pkg/cmd/release/progression/allow/allow.go index a295b708..34974e52 100644 --- a/pkg/cmd/release/progression/allow/allow.go +++ b/pkg/cmd/release/progression/allow/allow.go @@ -57,9 +57,9 @@ func NewCmdAllow(f factory.Factory) *cobra.Command { Short: "Allows a release to progress to the next phase.", Long: "Allows a release to progress to the next phase in Octopus Deploy.", Example: heredoc.Docf(` - $ %[1]s release progression allow --project MyProject --version 1.2.3 - $ %[1]s release progression allow -p MyProject -v 1.2.3 - $ %[1]s release progression allow -p MyProject -v 1.2.3 --no-prompt + %[1]s release progression allow --project MyProject --version 1.2.3 + %[1]s release progression allow -p MyProject -v 1.2.3 + %[1]s release progression allow -p MyProject -v 1.2.3 --no-prompt `, constants.ExecutableName), Aliases: []string{"allow-releaseprogression"}, RunE: func(c *cobra.Command, _ []string) error { diff --git a/pkg/cmd/release/progression/prevent/prevent.go b/pkg/cmd/release/progression/prevent/prevent.go index 5052df8a..e801ab86 100644 --- a/pkg/cmd/release/progression/prevent/prevent.go +++ b/pkg/cmd/release/progression/prevent/prevent.go @@ -61,9 +61,9 @@ func NewCmdPrevent(f factory.Factory) *cobra.Command { Short: "Prevents a release from progression to the next phase", Long: "Prevents a release from progression to the next phase in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s release progression prevent --project MyProject --version 1.2.3 --reason "It's broken" - $ %[1]s release progression prevent -p MyProject -v 1.2.3 -r "It's broken" - $ %[1]s release progression prevent -p MyProject -v 1.2.3 -r "It's broken" --no-prompt + %[1]s release progression prevent --project MyProject --version 1.2.3 --reason "It's broken" + %[1]s release progression prevent -p MyProject -v 1.2.3 -r "It's broken" + %[1]s release progression prevent -p MyProject -v 1.2.3 -r "It's broken" --no-prompt `, constants.ExecutableName), Aliases: []string{"prevent-releaseprogression"}, RunE: func(c *cobra.Command, _ []string) error { diff --git a/pkg/cmd/release/progression/progression.go b/pkg/cmd/release/progression/progression.go index 4b8733c7..b68ec213 100644 --- a/pkg/cmd/release/progression/progression.go +++ b/pkg/cmd/release/progression/progression.go @@ -15,8 +15,8 @@ func NewCmdProgression(f factory.Factory) *cobra.Command { Short: "Manage progression of a release", Long: "Manage progression of a release in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s release progression prevent - $ %[1]s release progression allow + %[1]s release progression prevent + %[1]s release progression allow `, constants.ExecutableName), } diff --git a/pkg/cmd/release/release.go b/pkg/cmd/release/release.go index ffc59133..a6da7735 100644 --- a/pkg/cmd/release/release.go +++ b/pkg/cmd/release/release.go @@ -18,7 +18,7 @@ func NewCmdRelease(f factory.Factory) *cobra.Command { Use: "release ", Short: "Manage releases", Long: "Manage releases in Octopus Deploy", - Example: heredoc.Docf("$ %s release list", constants.ExecutableName), + Example: heredoc.Docf("%s release list", constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", }, diff --git a/pkg/cmd/runbook/delete/delete.go b/pkg/cmd/runbook/delete/delete.go index f9b8dab3..bc0f6947 100644 --- a/pkg/cmd/runbook/delete/delete.go +++ b/pkg/cmd/runbook/delete/delete.go @@ -65,8 +65,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a runbook in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s runbook delete - $ %[1]s runbook rm + %[1]s runbook delete + %[1]s runbook rm `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { deps := cmd.NewDependencies(f, c) diff --git a/pkg/cmd/runbook/list/list.go b/pkg/cmd/runbook/list/list.go index 38782404..a3fcc2b1 100644 --- a/pkg/cmd/runbook/list/list.go +++ b/pkg/cmd/runbook/list/list.go @@ -2,9 +2,10 @@ package list import ( "errors" - "github.com/OctopusDeploy/cli/pkg/cmd/runbook/shared" "math" + "github.com/OctopusDeploy/cli/pkg/cmd/runbook/shared" + "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/MakeNowJust/heredoc/v2" @@ -50,9 +51,9 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List runbooks", Long: "List runbooks in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s runbook list SomeProject - $ %[1]s runbook list --project SomeProject --limit 50 --filter SomeKeyword - $ %[1]s runbook ls -p SomeProject -n 30 -q SomeKeyword + %[1]s runbook list SomeProject + %[1]s runbook list --project SomeProject --limit 50 --filter SomeKeyword + %[1]s runbook ls -p SomeProject -n 30 -q SomeKeyword `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/runbook/run/run.go b/pkg/cmd/runbook/run/run.go index 37c86533..a05f567a 100644 --- a/pkg/cmd/runbook/run/run.go +++ b/pkg/cmd/runbook/run/run.go @@ -4,15 +4,16 @@ import ( "encoding/json" "errors" "fmt" - "github.com/OctopusDeploy/cli/pkg/cmd/runbook/shared" - "github.com/OctopusDeploy/cli/pkg/packages" - "golang.org/x/exp/maps" "io" "math" "sort" "strings" "time" + "github.com/OctopusDeploy/cli/pkg/cmd/runbook/shared" + "github.com/OctopusDeploy/cli/pkg/packages" + "golang.org/x/exp/maps" + "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/AlecAivazis/survey/v2" @@ -145,8 +146,8 @@ func NewCmdRun(f factory.Factory) *cobra.Command { Short: "Run runbooks in Octopus Deploy", Long: "Run runbooks in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s runbook run # fully interactive - $ %[1]s runbook run --project MyProject --runbook "Rebuild DB indexes" + %[1]s runbook run # fully interactive + %[1]s runbook run --project MyProject --runbook "Rebuild DB indexes" `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { if len(args) > 0 && runFlags.Project.Value == "" { @@ -1348,4 +1349,3 @@ func findGitRunbook(octopus *octopusApiClient.Client, spaceID string, projectID } return result, err } - diff --git a/pkg/cmd/runbook/runbook.go b/pkg/cmd/runbook/runbook.go index a513c62a..d20bd5fe 100644 --- a/pkg/cmd/runbook/runbook.go +++ b/pkg/cmd/runbook/runbook.go @@ -18,8 +18,8 @@ func NewCmdRunbook(f factory.Factory) *cobra.Command { Short: "Manage runbooks", Long: "Manage runbooks in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s runbook list - $ %[1]s runbook run + %[1]s runbook list + %[1]s runbook run `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/runbook/snapshot/create/create.go b/pkg/cmd/runbook/snapshot/create/create.go index 288fc618..71a5a57b 100644 --- a/pkg/cmd/runbook/snapshot/create/create.go +++ b/pkg/cmd/runbook/snapshot/create/create.go @@ -92,10 +92,10 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Long: "Create a runbook snapshot in Octopus Deploy", Aliases: []string{"new"}, Example: heredoc.Docf(` - $ %[1]s runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" - $ %[1]s runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" --name "My cool snapshot" - $ %[1]s runbook snapshot create -p MyProject -r "Restart App" --package "azure-cli:1.2.3" --no-prompt - $ %[1]s runbook snapshot create -p MyProject -r "Restart App" --git-resource "Script step from Git:refs/heads/dev-branch" --publish --no-prompt + %[1]s runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" + %[1]s runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" --name "My cool snapshot" + %[1]s runbook snapshot create -p MyProject -r "Restart App" --package "azure-cli:1.2.3" --no-prompt + %[1]s runbook snapshot create -p MyProject -r "Restart App" --git-resource "Script step from Git:refs/heads/dev-branch" --publish --no-prompt `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/runbook/snapshot/list/list.go b/pkg/cmd/runbook/snapshot/list/list.go index 51e460e5..ee2c111b 100644 --- a/pkg/cmd/runbook/snapshot/list/list.go +++ b/pkg/cmd/runbook/snapshot/list/list.go @@ -2,6 +2,9 @@ package list import ( "errors" + "math" + "time" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/constants" @@ -12,8 +15,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projects" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/runbooks" "github.com/spf13/cobra" - "math" - "time" ) const ( @@ -50,8 +51,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List runbook snapshots", Long: "List runbook snapshots in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s runbook snapshot list --project "Deploy Web App" --runbook "Run maintenance" - $ %[1]s runbook snapshot ls + %[1]s runbook snapshot list --project "Deploy Web App" --runbook "Run maintenance" + %[1]s runbook snapshot ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/runbook/snapshot/publish/publish.go b/pkg/cmd/runbook/snapshot/publish/publish.go index 8e6d9144..e15b72c5 100644 --- a/pkg/cmd/runbook/snapshot/publish/publish.go +++ b/pkg/cmd/runbook/snapshot/publish/publish.go @@ -3,6 +3,9 @@ package publish import ( "errors" "fmt" + "math" + "time" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/runbook/shared" @@ -14,8 +17,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projects" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/runbooks" "github.com/spf13/cobra" - "math" - "time" ) const ( @@ -61,7 +62,7 @@ func NewCmdPublish(f factory.Factory) *cobra.Command { Short: "Publish a runbook snapshot", Long: "Publish a runbook snapshot in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s runbook snapshot publish --project MyProject --runbook "Rebuild DB Indexes" --snapshot "Snapshot 40C9ENM" + %[1]s runbook snapshot publish --project MyProject --runbook "Rebuild DB Indexes" --snapshot "Snapshot 40C9ENM" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewPublishOptions(publishFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/runbook/snapshot/snapshot.go b/pkg/cmd/runbook/snapshot/snapshot.go index 43f3d043..992cc971 100644 --- a/pkg/cmd/runbook/snapshot/snapshot.go +++ b/pkg/cmd/runbook/snapshot/snapshot.go @@ -16,8 +16,8 @@ func NewCmdSnapshot(f factory.Factory) *cobra.Command { Short: "Manage runbook snapshots", Long: "Manage runbook snapshots in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s runbook snapshot create - $ %[1]s runbook snapshot list + %[1]s runbook snapshot create + %[1]s runbook snapshot list `, constants.ExecutableName), } diff --git a/pkg/cmd/space/create/create.go b/pkg/cmd/space/create/create.go index cf81fa4b..4e085c01 100644 --- a/pkg/cmd/space/create/create.go +++ b/pkg/cmd/space/create/create.go @@ -78,7 +78,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a space", Long: "Create a space in Octopus Deploy", - Example: heredoc.Docf("$ %s space create", constants.ExecutableName), + Example: heredoc.Docf("%s space create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, args []string) error { opts := NewCreateOptions(f, createFlags, c) diff --git a/pkg/cmd/space/delete/delete.go b/pkg/cmd/space/delete/delete.go index 050f86b7..98451766 100644 --- a/pkg/cmd/space/delete/delete.go +++ b/pkg/cmd/space/delete/delete.go @@ -2,6 +2,7 @@ package delete import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/constants" @@ -23,8 +24,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a space in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s space delete - $ %[1]s space rm + %[1]s space delete + %[1]s space rm `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { if len(args) == 0 { diff --git a/pkg/cmd/space/list/list.go b/pkg/cmd/space/list/list.go index ea2afbe5..ac72d002 100644 --- a/pkg/cmd/space/list/list.go +++ b/pkg/cmd/space/list/list.go @@ -15,7 +15,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Use: "list", Short: "List spaces", Long: "List spaces in Octopus Deploy", - Example: heredoc.Docf("$ %s space list", constants.ExecutableName), + Example: heredoc.Docf("%s space list", constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { return listRun(f, cmd) diff --git a/pkg/cmd/space/space.go b/pkg/cmd/space/space.go index 861133c1..8c69eb9a 100644 --- a/pkg/cmd/space/space.go +++ b/pkg/cmd/space/space.go @@ -18,8 +18,8 @@ func NewCmdSpace(f factory.Factory) *cobra.Command { Short: "Manage spaces", Long: "Manage spaces in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s space list - $ %[1]s space view Spaces-302 + %[1]s space list + %[1]s space view Spaces-302 `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsConfiguration: "true", diff --git a/pkg/cmd/space/view/view.go b/pkg/cmd/space/view/view.go index ca046268..0e56b334 100644 --- a/pkg/cmd/space/view/view.go +++ b/pkg/cmd/space/view/view.go @@ -2,9 +2,10 @@ package view import ( "fmt" - "github.com/OctopusDeploy/cli/pkg/apiclient" "strings" + "github.com/OctopusDeploy/cli/pkg/apiclient" + "github.com/OctopusDeploy/cli/pkg/factory" "github.com/OctopusDeploy/cli/pkg/usage" @@ -32,8 +33,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a space", Long: "View a space in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s space view 'Pattern - Blue-Green' - $ %[1]s space view Spaces-302 + %[1]s space view 'Pattern - Blue-Green' + %[1]s space view Spaces-302 `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSystemClient(apiclient.NewRequester(cmd)) @@ -117,7 +118,7 @@ func generateWebUrl(host string, space *spaces.Space) string { func formatSpaceForBasic(host string, space *spaces.Space) string { var result strings.Builder - + // header result.WriteString(fmt.Sprintf("%s %s\n", output.Bold(space.Name), output.Dimf("(%s)", space.GetID()))) diff --git a/pkg/cmd/target/azure-web-app/azure-web-app.go b/pkg/cmd/target/azure-web-app/azure-web-app.go index 7144f136..5b8d3dd8 100644 --- a/pkg/cmd/target/azure-web-app/azure-web-app.go +++ b/pkg/cmd/target/azure-web-app/azure-web-app.go @@ -16,7 +16,7 @@ func NewCmdAzureWebApp(f factory.Factory) *cobra.Command { Use: "azure-web-app ", Short: "Manage Azure Web App deployment targets", Long: "Manage Azure Web App deployment targets in Octopus Deploy", - Example: fmt.Sprintf("$ %s deployment-target azure-web-app list", constants.ExecutableName), + Example: fmt.Sprintf("%s deployment-target azure-web-app list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/target/azure-web-app/create/create.go b/pkg/cmd/target/azure-web-app/create/create.go index 55a2e5ae..902fabc5 100644 --- a/pkg/cmd/target/azure-web-app/create/create.go +++ b/pkg/cmd/target/azure-web-app/create/create.go @@ -104,7 +104,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create an Azure Web App deployment target", Long: "Create an Azure Web App deployment target in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target azure-web-app create", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target azure-web-app create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/target/azure-web-app/list/list.go b/pkg/cmd/target/azure-web-app/list/list.go index 2b71d8ce..1273eb0f 100644 --- a/pkg/cmd/target/azure-web-app/list/list.go +++ b/pkg/cmd/target/azure-web-app/list/list.go @@ -16,8 +16,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List Azure Web App deployment targets", Long: "List Azure Web App deployment targets in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target azure-web-app list - $ %[1]s deployment-target azure-web-app ls + %[1]s deployment-target azure-web-app list + %[1]s deployment-target azure-web-app ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/target/azure-web-app/view/view.go b/pkg/cmd/target/azure-web-app/view/view.go index 24f77058..2d65321b 100644 --- a/pkg/cmd/target/azure-web-app/view/view.go +++ b/pkg/cmd/target/azure-web-app/view/view.go @@ -2,9 +2,10 @@ package view import ( "fmt" - "github.com/OctopusDeploy/cli/pkg/output" "strings" + "github.com/OctopusDeploy/cli/pkg/output" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/target/shared" @@ -24,8 +25,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View an Azure Web App deployment target", Long: "View an Azure Web App deployment target in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target azure-web-app view 'Shop Api' - $ %[1]s deployment-target azure-web-app view Machines-100 + %[1]s deployment-target azure-web-app view 'Shop Api' + %[1]s deployment-target azure-web-app view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/target/cloud-region/cloud-region.go b/pkg/cmd/target/cloud-region/cloud-region.go index 1278182d..a74948ed 100644 --- a/pkg/cmd/target/cloud-region/cloud-region.go +++ b/pkg/cmd/target/cloud-region/cloud-region.go @@ -15,7 +15,7 @@ func NewCmdCloudRegion(f factory.Factory) *cobra.Command { Use: "cloud-region ", Short: "Manage Cloud Region deployment targets", Long: "Manage Cloud Region deployment targets in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target cloud-region list", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target cloud-region list", constants.ExecutableName), } cmd.AddCommand(cmdCreate.NewCmdCreate(f)) diff --git a/pkg/cmd/target/cloud-region/create/create.go b/pkg/cmd/target/cloud-region/create/create.go index 84368d9e..ca73e7ef 100644 --- a/pkg/cmd/target/cloud-region/create/create.go +++ b/pkg/cmd/target/cloud-region/create/create.go @@ -69,7 +69,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a Cloud Region deployment target", Long: "Create a Cloud Region deployment target in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target cloud-region create", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target cloud-region create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/target/cloud-region/list/list.go b/pkg/cmd/target/cloud-region/list/list.go index 4c9d8131..0510e39c 100644 --- a/pkg/cmd/target/cloud-region/list/list.go +++ b/pkg/cmd/target/cloud-region/list/list.go @@ -16,8 +16,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List Cloud Region deployment targets", Long: "List Cloud Region deployment targets in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target cloud-region list - $ %[1]s deployment-target cloud-region ls + %[1]s deployment-target cloud-region list + %[1]s deployment-target cloud-region ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/target/cloud-region/view/view.go b/pkg/cmd/target/cloud-region/view/view.go index b0593ac1..c1e2be92 100644 --- a/pkg/cmd/target/cloud-region/view/view.go +++ b/pkg/cmd/target/cloud-region/view/view.go @@ -19,8 +19,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a Cloud Region deployment target", Long: "View a Cloud Region deployment target in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target cloud-region view 'EU' - $ %[1]s deployment-target cloud-region view Machines-100 + %[1]s deployment-target cloud-region view 'EU' + %[1]s deployment-target cloud-region view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/target/delete/delete.go b/pkg/cmd/target/delete/delete.go index 5d057287..ef8fb8da 100644 --- a/pkg/cmd/target/delete/delete.go +++ b/pkg/cmd/target/delete/delete.go @@ -38,8 +38,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a deployment target in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s deployment-target delete - $ %[1]s deployment-target rm + %[1]s deployment-target delete + %[1]s deployment-target rm `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { deps := cmd.NewDependencies(f, c) diff --git a/pkg/cmd/target/kubernetes/create/create.go b/pkg/cmd/target/kubernetes/create/create.go index 4075fec1..08a86416 100644 --- a/pkg/cmd/target/kubernetes/create/create.go +++ b/pkg/cmd/target/kubernetes/create/create.go @@ -249,7 +249,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a Kubernetes deployment target", Long: "Create a Kubernetes deployment target in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target kubernetes create", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target kubernetes create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/target/kubernetes/kubernetes.go b/pkg/cmd/target/kubernetes/kubernetes.go index a2f81dc6..70d6fcc2 100644 --- a/pkg/cmd/target/kubernetes/kubernetes.go +++ b/pkg/cmd/target/kubernetes/kubernetes.go @@ -15,7 +15,7 @@ func NewCmdKubernetes(f factory.Factory) *cobra.Command { Use: "kubernetes ", Short: "Manage Kubernetes deployment targets", Long: "Manage Kubernetes deployment targets in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target kubernetes create", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target kubernetes create", constants.ExecutableName), Aliases: []string{"k8s"}, } diff --git a/pkg/cmd/target/kubernetes/list/list.go b/pkg/cmd/target/kubernetes/list/list.go index b6999fc5..b2bf16fd 100644 --- a/pkg/cmd/target/kubernetes/list/list.go +++ b/pkg/cmd/target/kubernetes/list/list.go @@ -16,8 +16,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List Kubernetes deployment targets", Long: "List Kubernetes deployment targets in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target kubernetes list - $ %[1]s deployment-target kubernetes ls + %[1]s deployment-target kubernetes list + %[1]s deployment-target kubernetes ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, _ []string) error { diff --git a/pkg/cmd/target/kubernetes/view/view.go b/pkg/cmd/target/kubernetes/view/view.go index ebccb5f2..e354d064 100644 --- a/pkg/cmd/target/kubernetes/view/view.go +++ b/pkg/cmd/target/kubernetes/view/view.go @@ -21,7 +21,7 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a Kubernetes deployment target", Long: "View a Kubernetes deployment target in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target kubernetes view 'target-name' + %[1]s deployment-target kubernetes view 'target-name' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/target/list/list.go b/pkg/cmd/target/list/list.go index 0b324891..1b28b5c6 100644 --- a/pkg/cmd/target/list/list.go +++ b/pkg/cmd/target/list/list.go @@ -37,8 +37,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List deployment targets", Long: "List deployment targets in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target list - $ %[1]s deployment-target ls + %[1]s deployment-target list + %[1]s deployment-target ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/target/listening-tentacle/create/create.go b/pkg/cmd/target/listening-tentacle/create/create.go index 2ba9f2bb..30f35ec9 100644 --- a/pkg/cmd/target/listening-tentacle/create/create.go +++ b/pkg/cmd/target/listening-tentacle/create/create.go @@ -81,7 +81,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a Listening Tentacle deployment target", Long: "Create a Listening Tentacle deployment target in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target listening-tentacle create", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target listening-tentacle create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/target/listening-tentacle/list/list.go b/pkg/cmd/target/listening-tentacle/list/list.go index 058a4184..aa000cb3 100644 --- a/pkg/cmd/target/listening-tentacle/list/list.go +++ b/pkg/cmd/target/listening-tentacle/list/list.go @@ -16,8 +16,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List Listening Tentacle deployment targets", Long: "List Listening Tentacle deployment targets in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target listening-tentacle list - $ %[1]s deployment-target listening-tentacle ls + %[1]s deployment-target listening-tentacle list + %[1]s deployment-target listening-tentacle ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/target/listening-tentacle/listening-tentacle.go b/pkg/cmd/target/listening-tentacle/listening-tentacle.go index 160f5ecc..bb72a519 100644 --- a/pkg/cmd/target/listening-tentacle/listening-tentacle.go +++ b/pkg/cmd/target/listening-tentacle/listening-tentacle.go @@ -15,7 +15,7 @@ func NewCmdListeningTentacle(f factory.Factory) *cobra.Command { Use: "listening-tentacle ", Short: "Manage Listening Tentacle deployment targets", Long: "Manage Listening Tentacle deployment targets in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target listening-tentacle list", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target listening-tentacle list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/target/listening-tentacle/view/view.go b/pkg/cmd/target/listening-tentacle/view/view.go index 19b237a5..2010d08f 100644 --- a/pkg/cmd/target/listening-tentacle/view/view.go +++ b/pkg/cmd/target/listening-tentacle/view/view.go @@ -21,8 +21,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a Listening Tentacle deployment target", Long: "View a Listening Tentacle deployment target in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target listening-tentacle view 'EU' - $ %[1]s deployment-target listening-tentacle view Machines-100 + %[1]s deployment-target listening-tentacle view 'EU' + %[1]s deployment-target listening-tentacle view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/target/polling-tentacle/list/list.go b/pkg/cmd/target/polling-tentacle/list/list.go index 8cd4074d..cdcbd678 100644 --- a/pkg/cmd/target/polling-tentacle/list/list.go +++ b/pkg/cmd/target/polling-tentacle/list/list.go @@ -16,8 +16,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List Polling Tentacle deployment targets", Long: "List Polling Tentacle deployment targets in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target polling-tentacle list - $ %[1]s deployment-target polling-tentacle ls + %[1]s deployment-target polling-tentacle list + %[1]s deployment-target polling-tentacle ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/target/polling-tentacle/polling-tentacle.go b/pkg/cmd/target/polling-tentacle/polling-tentacle.go index c108034f..a7e38823 100644 --- a/pkg/cmd/target/polling-tentacle/polling-tentacle.go +++ b/pkg/cmd/target/polling-tentacle/polling-tentacle.go @@ -14,7 +14,7 @@ func NewCmdPollingTentacle(f factory.Factory) *cobra.Command { Use: "polling-tentacle ", Short: "Manage Polling Tentacle deployment targets", Long: "Manage Polling Tentacle deployment targets in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target polling-tentacle list", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target polling-tentacle list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/target/polling-tentacle/view/view.go b/pkg/cmd/target/polling-tentacle/view/view.go index e2fa3bd4..cc0f4699 100644 --- a/pkg/cmd/target/polling-tentacle/view/view.go +++ b/pkg/cmd/target/polling-tentacle/view/view.go @@ -21,8 +21,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a Polling Tentacle deployment target", Long: "View a Polling Tentacle deployment target in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target polling-tentacle view 'EU' - $ %[1]s deployment-target polling-tentacle view Machines-100 + %[1]s deployment-target polling-tentacle view 'EU' + %[1]s deployment-target polling-tentacle view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/target/ssh/create/create.go b/pkg/cmd/target/ssh/create/create.go index 20f442f2..504378fd 100644 --- a/pkg/cmd/target/ssh/create/create.go +++ b/pkg/cmd/target/ssh/create/create.go @@ -2,6 +2,7 @@ package create import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/target/shared" @@ -81,7 +82,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a SSH deployment target", Long: "Create a SSH deployment target in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target ssh create", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target ssh create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/target/ssh/list/list.go b/pkg/cmd/target/ssh/list/list.go index d9877bcd..de5825ad 100644 --- a/pkg/cmd/target/ssh/list/list.go +++ b/pkg/cmd/target/ssh/list/list.go @@ -16,8 +16,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List SSH deployment targets", Long: "List SSH deployment targets in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target ssh list - $ %[1]s deployment-target ssh ls + %[1]s deployment-target ssh list + %[1]s deployment-target ssh ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { diff --git a/pkg/cmd/target/ssh/ssh.go b/pkg/cmd/target/ssh/ssh.go index 23c3425a..5530900e 100644 --- a/pkg/cmd/target/ssh/ssh.go +++ b/pkg/cmd/target/ssh/ssh.go @@ -15,7 +15,7 @@ func NewCmdSsh(f factory.Factory) *cobra.Command { Use: "ssh ", Short: "Manage SSH deployment targets", Long: "Manage SSH deployment targets in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target ssh create", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target ssh create", constants.ExecutableName), } cmd.AddCommand(cmdCreate.NewCmdCreate(f)) diff --git a/pkg/cmd/target/ssh/view/view.go b/pkg/cmd/target/ssh/view/view.go index 722f02ae..c733c4d4 100644 --- a/pkg/cmd/target/ssh/view/view.go +++ b/pkg/cmd/target/ssh/view/view.go @@ -21,8 +21,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a SSH deployment target", Long: "View a SSH deployment target in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target ssh view 'linux-web-server' - $ %[1]s deployment-target ssh view Machines-100 + %[1]s deployment-target ssh view 'linux-web-server' + %[1]s deployment-target ssh view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/target/target.go b/pkg/cmd/target/target.go index 6c5c0fc0..aa6129a2 100644 --- a/pkg/cmd/target/target.go +++ b/pkg/cmd/target/target.go @@ -22,7 +22,7 @@ func NewCmdDeploymentTarget(f factory.Factory) *cobra.Command { Use: "deployment-target ", Short: "Manage deployment targets", Long: "Manage deployment targets in Octopus Deploy", - Example: heredoc.Docf("$ %s deployment-target list", constants.ExecutableName), + Example: heredoc.Docf("%s deployment-target list", constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", }, diff --git a/pkg/cmd/target/view/view.go b/pkg/cmd/target/view/view.go index c3e30725..fa270f95 100644 --- a/pkg/cmd/target/view/view.go +++ b/pkg/cmd/target/view/view.go @@ -25,8 +25,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a deployment target", Long: "View a deployment target in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s deployment-target view Machines-100 - $ %[1]s deployment-target view 'web-server' + %[1]s deployment-target view Machines-100 + %[1]s deployment-target view 'web-server' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { return ViewRun(shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c)) diff --git a/pkg/cmd/task/wait/wait.go b/pkg/cmd/task/wait/wait.go index 069fb595..7d98da69 100644 --- a/pkg/cmd/task/wait/wait.go +++ b/pkg/cmd/task/wait/wait.go @@ -76,7 +76,7 @@ func NewCmdWait(f factory.Factory) *cobra.Command { Use: "wait [TaskIDs]", Short: "Wait for task(s) to finish", Long: "Wait for a provided list of task(s) to finish", - Example: heredoc.Docf("$ %s task wait", constants.ExecutableName), + Example: heredoc.Docf("%s task wait", constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { taskIDs := make([]string, len(args)) copy(taskIDs, args) diff --git a/pkg/cmd/tenant/clone/clone.go b/pkg/cmd/tenant/clone/clone.go index 277e2860..67c01a1d 100644 --- a/pkg/cmd/tenant/clone/clone.go +++ b/pkg/cmd/tenant/clone/clone.go @@ -2,6 +2,7 @@ package clone import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/tenant/shared" @@ -64,8 +65,8 @@ func NewCmdClone(f factory.Factory) *cobra.Command { Short: "Clone a tenant", Long: "Clone a tenant in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant clone - $ %[1]s tenant clone --name "Gary's Cakes" --source-tenant "Bob's Wood Shop" + %[1]s tenant clone + %[1]s tenant clone --name "Gary's Cakes" --source-tenant "Bob's Wood Shop" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewCloneOptions(cloneFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/tenant/connect/connect.go b/pkg/cmd/tenant/connect/connect.go index cd94fdd7..6cfc6308 100644 --- a/pkg/cmd/tenant/connect/connect.go +++ b/pkg/cmd/tenant/connect/connect.go @@ -87,8 +87,8 @@ func NewCmdConnect(f factory.Factory) *cobra.Command { Short: "Connect a tenant to a project", Long: "Connect a tenant to a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant connect - $ %[1]s tenant connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" + %[1]s tenant connect + %[1]s tenant connect --tenant "Bobs Wood Shop" --project "Deploy web site" --environment "Production" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewConnectOptions(connectFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/tenant/create/create.go b/pkg/cmd/tenant/create/create.go index d9a64b8f..80a4d454 100644 --- a/pkg/cmd/tenant/create/create.go +++ b/pkg/cmd/tenant/create/create.go @@ -40,7 +40,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a tenant", Long: "Create a tenant in Octopus Deploy", - Example: heredoc.Docf("$ %s tenant create", constants.ExecutableName), + Example: heredoc.Docf("%s tenant create", constants.ExecutableName), Aliases: []string{"new"}, RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) @@ -115,4 +115,3 @@ func PromptMissing(opts *CreateOptions) ([]cmd.Dependable, error) { nestedOpts = append(nestedOpts, opts) return nestedOpts, nil } - diff --git a/pkg/cmd/tenant/delete/delete.go b/pkg/cmd/tenant/delete/delete.go index bc3ab2d4..3cec43f9 100644 --- a/pkg/cmd/tenant/delete/delete.go +++ b/pkg/cmd/tenant/delete/delete.go @@ -2,6 +2,7 @@ package delete import ( "fmt" + "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/MakeNowJust/heredoc/v2" @@ -30,8 +31,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a tenant in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s tenant delete - $ %[1]s tenant rm + %[1]s tenant delete + %[1]s tenant rm `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(c)) diff --git a/pkg/cmd/tenant/disable/disable.go b/pkg/cmd/tenant/disable/disable.go index 8f37bc92..8c8bb8db 100644 --- a/pkg/cmd/tenant/disable/disable.go +++ b/pkg/cmd/tenant/disable/disable.go @@ -2,6 +2,7 @@ package disable import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/constants" @@ -29,8 +30,8 @@ func NewCmdDisable(f factory.Factory) *cobra.Command { Short: "Disable a tenant", Long: "Disable a tenant in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant disable Tenants-1 - $ %[1]s tenant disable 'Tenant' + %[1]s tenant disable Tenants-1 + %[1]s tenant disable 'Tenant' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { diff --git a/pkg/cmd/tenant/disconnect/disconnect.go b/pkg/cmd/tenant/disconnect/disconnect.go index d7a99cdb..01c144de 100644 --- a/pkg/cmd/tenant/disconnect/disconnect.go +++ b/pkg/cmd/tenant/disconnect/disconnect.go @@ -71,8 +71,8 @@ func NewCmdDisconnect(f factory.Factory) *cobra.Command { Short: "Disconnect a tenant from a project", Long: "Disconnect a tenant from a project in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant disconnect - $ %[1]s tenant disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm + %[1]s tenant disconnect + %[1]s tenant disconnect --tenant "Test Tenant" --project "Deploy web site" --confirm `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewDisconnectOptions(disconnectFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/tenant/enable/enable.go b/pkg/cmd/tenant/enable/enable.go index 5070c9ea..081255df 100644 --- a/pkg/cmd/tenant/enable/enable.go +++ b/pkg/cmd/tenant/enable/enable.go @@ -2,6 +2,7 @@ package enable import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/constants" @@ -29,8 +30,8 @@ func NewCmdEnable(f factory.Factory) *cobra.Command { Short: "Enable a tenant", Long: "Enable a tenant in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant enable Tenants-1 - $ %[1]s tenant enable 'Tenant' + %[1]s tenant enable Tenants-1 + %[1]s tenant enable 'Tenant' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { diff --git a/pkg/cmd/tenant/list/list.go b/pkg/cmd/tenant/list/list.go index 272e0884..b6cf67e9 100644 --- a/pkg/cmd/tenant/list/list.go +++ b/pkg/cmd/tenant/list/list.go @@ -1,6 +1,8 @@ package list import ( + "strconv" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/cmd/tenant/shared" @@ -9,7 +11,6 @@ import ( "github.com/OctopusDeploy/cli/pkg/output" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/tenants" "github.com/spf13/cobra" - "strconv" ) func NewCmdList(f factory.Factory) *cobra.Command { @@ -18,8 +19,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List tenants", Long: "List tenants in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant list - $ %[1]s tenant ls + %[1]s tenant list + %[1]s tenant ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/tenant/tag/tag.go b/pkg/cmd/tenant/tag/tag.go index 07b21324..5382fa6e 100644 --- a/pkg/cmd/tenant/tag/tag.go +++ b/pkg/cmd/tenant/tag/tag.go @@ -40,7 +40,7 @@ func NewCmdTag(f factory.Factory) *cobra.Command { Use: "tag", Short: "Override tags for a tenant", Long: "Override tags for a tenant in Octopus Deploy", - Example: heredoc.Docf("$ %s tenant tag Tenant-1", constants.ExecutableName), + Example: heredoc.Docf("%s tenant tag Tenant-1", constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewTagOptions(createFlags, cmd.NewDependencies(f, c)) @@ -146,4 +146,3 @@ func AskTenants(ask question.Asker, out io.Writer, value string, getTenantsCallb return tenant, nil } - diff --git a/pkg/cmd/tenant/tenant.go b/pkg/cmd/tenant/tenant.go index aceb60e8..3e3e62d1 100644 --- a/pkg/cmd/tenant/tenant.go +++ b/pkg/cmd/tenant/tenant.go @@ -25,8 +25,8 @@ func NewCmdTenant(f factory.Factory) *cobra.Command { Short: "Manage tenants", Long: "Manage tenants in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant list - $ %[1]s tenant ls + %[1]s tenant list + %[1]s tenant ls `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/tenant/variables/list/list.go b/pkg/cmd/tenant/variables/list/list.go index 4ffe0ca2..d5dc72b4 100644 --- a/pkg/cmd/tenant/variables/list/list.go +++ b/pkg/cmd/tenant/variables/list/list.go @@ -2,6 +2,8 @@ package list import ( "fmt" + "sort" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/constants" @@ -15,7 +17,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/tenants" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/variables" "github.com/spf13/cobra" - "sort" ) const ( @@ -76,8 +77,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List tenant variables", Long: "List tenant variables in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant variables list "Bobs Wood Shop" - $ %[1]s tenant variables ls Tenant-123 + %[1]s tenant variables list "Bobs Wood Shop" + %[1]s tenant variables ls Tenant-123 `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/tenant/variables/update/update.go b/pkg/cmd/tenant/variables/update/update.go index 7e82fab3..3cdafcb0 100644 --- a/pkg/cmd/tenant/variables/update/update.go +++ b/pkg/cmd/tenant/variables/update/update.go @@ -2,6 +2,9 @@ package update import ( "fmt" + "sort" + "strings" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/tenant/shared" @@ -23,8 +26,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/variables" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/workerpools" "github.com/spf13/cobra" - "sort" - "strings" ) const ( @@ -104,9 +105,9 @@ func NewCmdUpdate(f factory.Factory) *cobra.Command { Short: "Update the value of a tenant variable", Long: "Update the value of a tenant variable in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant variables update - $ %[1]s tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" - $ %[1]s tenant variables update --tenant "Sally's Tackle Truck" --name dbPassword --value "12345" --library-variable-set "Shared Variables" + %[1]s tenant variables update + %[1]s tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" + %[1]s tenant variables update --tenant "Sally's Tackle Truck" --name dbPassword --value "12345" --library-variable-set "Shared Variables" `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := NewUpdateOptions(updateFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/tenant/variables/variables.go b/pkg/cmd/tenant/variables/variables.go index 39bdbc9b..31cf72d5 100644 --- a/pkg/cmd/tenant/variables/variables.go +++ b/pkg/cmd/tenant/variables/variables.go @@ -17,8 +17,8 @@ func NewCmdVariables(f factory.Factory) *cobra.Command { Short: "Manage tenant variables", Long: "Manage tenant variables in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant variables list "Bobs Wood Shop" - $ %[1]s tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" + %[1]s tenant variables list "Bobs Wood Shop" + %[1]s tenant variables update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test" `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/tenant/view/view.go b/pkg/cmd/tenant/view/view.go index f29f6604..77d9fc9a 100644 --- a/pkg/cmd/tenant/view/view.go +++ b/pkg/cmd/tenant/view/view.go @@ -52,8 +52,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a tenant", Long: "View a tenant in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s tenant view Tenants-1 - $ %[1]s tenant view 'Tenant' + %[1]s tenant view Tenants-1 + %[1]s tenant view 'Tenant' `, constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { client, err := f.GetSpacedClient(apiclient.NewRequester(cmd)) diff --git a/pkg/cmd/user/delete/delete.go b/pkg/cmd/user/delete/delete.go index 77aaf815..4c4f9037 100644 --- a/pkg/cmd/user/delete/delete.go +++ b/pkg/cmd/user/delete/delete.go @@ -2,6 +2,8 @@ package delete import ( "fmt" + "strings" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/apiclient" "github.com/OctopusDeploy/cli/pkg/constants" @@ -11,7 +13,6 @@ import ( "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/client" "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/users" "github.com/spf13/cobra" - "strings" ) type DeleteOptions struct { @@ -30,8 +31,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a user in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s user delete some-user-name - $ %[1]s user rm Users-123 + %[1]s user delete some-user-name + %[1]s user rm Users-123 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { octopus, err := f.GetSpacedClient(apiclient.NewRequester(c)) diff --git a/pkg/cmd/user/list/list.go b/pkg/cmd/user/list/list.go index f9dd7fee..59ba03fe 100644 --- a/pkg/cmd/user/list/list.go +++ b/pkg/cmd/user/list/list.go @@ -23,8 +23,8 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List users", Long: "List users in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s user list - $ %[1]s user ls + %[1]s user list + %[1]s user ls `, constants.ExecutableName), Aliases: []string{"ls"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/user/user.go b/pkg/cmd/user/user.go index 4327a1b1..763e5760 100644 --- a/pkg/cmd/user/user.go +++ b/pkg/cmd/user/user.go @@ -16,8 +16,8 @@ func NewCmdUser(f factory.Factory) *cobra.Command { Short: "Manage users", Long: "Manage user in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s user list - $ %[1]s user ls + %[1]s user list + %[1]s user ls `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/version/version.go b/pkg/cmd/version/version.go index c8283830..7c34a1f0 100644 --- a/pkg/cmd/version/version.go +++ b/pkg/cmd/version/version.go @@ -11,7 +11,7 @@ func NewCmdVersion(f factory.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "version", Hidden: true, - Example: heredoc.Docf("$ %s version", constants.ExecutableName), + Example: heredoc.Docf("%s version", constants.ExecutableName), RunE: func(cmd *cobra.Command, args []string) error { cmd.Println(f.BuildVersion()) return nil diff --git a/pkg/cmd/worker/delete/delete.go b/pkg/cmd/worker/delete/delete.go index 35fcd827..4447e58c 100644 --- a/pkg/cmd/worker/delete/delete.go +++ b/pkg/cmd/worker/delete/delete.go @@ -39,8 +39,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a worker in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s worker delete - $ %[1]s worker rm + %[1]s worker delete + %[1]s worker rm `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { deps := cmd.NewDependencies(f, c) diff --git a/pkg/cmd/worker/list/list.go b/pkg/cmd/worker/list/list.go index cc6d15cc..ff3daf2e 100644 --- a/pkg/cmd/worker/list/list.go +++ b/pkg/cmd/worker/list/list.go @@ -34,7 +34,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List workers", Long: "List workers in Octopus Deploy", Aliases: []string{"ls"}, - Example: heredoc.Docf("$ %s worker list", constants.ExecutableName), + Example: heredoc.Docf("%s worker list", constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { return ListRun(NewListOptions(cmd.NewDependencies(f, c), c, nil)) }, diff --git a/pkg/cmd/worker/listening-tentacle/create/create.go b/pkg/cmd/worker/listening-tentacle/create/create.go index d43cea89..e629eca3 100644 --- a/pkg/cmd/worker/listening-tentacle/create/create.go +++ b/pkg/cmd/worker/listening-tentacle/create/create.go @@ -71,7 +71,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create a listening tentacle worker", Long: "Create a listening tentacle worker in Octopus Deploy", Example: heredoc.Docf(` - $ %s worker listening-tentacle create + %s worker listening-tentacle create `, constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/worker/listening-tentacle/list/list.go b/pkg/cmd/worker/listening-tentacle/list/list.go index d7d2bb39..fdbaf96d 100644 --- a/pkg/cmd/worker/listening-tentacle/list/list.go +++ b/pkg/cmd/worker/listening-tentacle/list/list.go @@ -17,7 +17,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Long: "List Listening Tentacle workers in Octopus Deploy", Aliases: []string{"ls"}, Example: heredoc.Docf(` - $ %s worker listening-tentacle list + %s worker listening-tentacle list `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { dependencies := cmd.NewDependencies(f, c) diff --git a/pkg/cmd/worker/listening-tentacle/listening-tentacle.go b/pkg/cmd/worker/listening-tentacle/listening-tentacle.go index cf127443..c82e0b58 100644 --- a/pkg/cmd/worker/listening-tentacle/listening-tentacle.go +++ b/pkg/cmd/worker/listening-tentacle/listening-tentacle.go @@ -16,7 +16,7 @@ func NewCmdListeningTentacle(f factory.Factory) *cobra.Command { Use: "listening-tentacle ", Short: "Manage Listening Tentacle workers", Long: "Manage Listening Tentacle workers in Octopus Deploy", - Example: fmt.Sprintf("$ %s worker listening-tentacle list", constants.ExecutableName), + Example: fmt.Sprintf("%s worker listening-tentacle list", constants.ExecutableName), } cmd.AddCommand(cmdCreate.NewCmdCreate(f)) diff --git a/pkg/cmd/worker/listening-tentacle/view/view.go b/pkg/cmd/worker/listening-tentacle/view/view.go index bee24736..789f3bb0 100644 --- a/pkg/cmd/worker/listening-tentacle/view/view.go +++ b/pkg/cmd/worker/listening-tentacle/view/view.go @@ -21,8 +21,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a Listening Tentacle worker", Long: "View a Listening Tentacle worker in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker listening-tentacle view 'WindowsWorker' - $ %[1]s worker listening-tentacle view Machines-100 + %[1]s worker listening-tentacle view 'WindowsWorker' + %[1]s worker listening-tentacle view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/worker/polling-tentacle/list/list.go b/pkg/cmd/worker/polling-tentacle/list/list.go index 4022dbcb..5c85b09d 100644 --- a/pkg/cmd/worker/polling-tentacle/list/list.go +++ b/pkg/cmd/worker/polling-tentacle/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List Polling Tentacle workers", Long: "List Polling Tentacle workers in Octopus Deploy", Aliases: []string{"ls"}, - Example: heredoc.Docf("$ %s worker polling-tentacle list", constants.ExecutableName), + Example: heredoc.Docf("%s worker polling-tentacle list", constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { dependencies := cmd.NewDependencies(f, c) options := list.NewListOptions(dependencies, c, func(worker *machines.Worker) bool { diff --git a/pkg/cmd/worker/polling-tentacle/polling-tentacle.go b/pkg/cmd/worker/polling-tentacle/polling-tentacle.go index 8e38d30b..3445ed09 100644 --- a/pkg/cmd/worker/polling-tentacle/polling-tentacle.go +++ b/pkg/cmd/worker/polling-tentacle/polling-tentacle.go @@ -15,7 +15,7 @@ func NewCmdPollingTentacle(f factory.Factory) *cobra.Command { Use: "polling-tentacle ", Short: "Manage Polling Tentacle workers", Long: "Manage Polling Tentacle workers in Octopus Deploy", - Example: fmt.Sprintf("$ %s worker polling-tentacle list", constants.ExecutableName), + Example: fmt.Sprintf("%s worker polling-tentacle list", constants.ExecutableName), } cmd.AddCommand(cmdList.NewCmdList(f)) diff --git a/pkg/cmd/worker/polling-tentacle/view/view.go b/pkg/cmd/worker/polling-tentacle/view/view.go index 0474bd06..50462300 100644 --- a/pkg/cmd/worker/polling-tentacle/view/view.go +++ b/pkg/cmd/worker/polling-tentacle/view/view.go @@ -21,8 +21,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a Polling Tentacle worker", Long: "View a Polling Tentacle worker in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker polling-tentacle view 'WindowsWorker' - $ %[1]s worker polling-tentacle view Machines-100 + %[1]s worker polling-tentacle view 'WindowsWorker' + %[1]s worker polling-tentacle view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/worker/ssh/create/create.go b/pkg/cmd/worker/ssh/create/create.go index c18af0ca..2028b409 100644 --- a/pkg/cmd/worker/ssh/create/create.go +++ b/pkg/cmd/worker/ssh/create/create.go @@ -2,6 +2,7 @@ package create import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/worker/shared" @@ -65,7 +66,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Use: "create", Short: "Create a SSH worker", Long: "Create a SSH worker in Octopus Deploy", - Example: heredoc.Docf("$ %s worker ssh create", constants.ExecutableName), + Example: heredoc.Docf("%s worker ssh create", constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/worker/ssh/list/list.go b/pkg/cmd/worker/ssh/list/list.go index 5bbb3ccc..2106b1c8 100644 --- a/pkg/cmd/worker/ssh/list/list.go +++ b/pkg/cmd/worker/ssh/list/list.go @@ -16,7 +16,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List SSH workers", Long: "List SSH workers in Octopus Deploy", Aliases: []string{"ls"}, - Example: heredoc.Docf("$ %s worker ssh list", constants.ExecutableName), + Example: heredoc.Docf("%s worker ssh list", constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { dependencies := cmd.NewDependencies(f, c) options := list.NewListOptions(dependencies, c, func(worker *machines.Worker) bool { diff --git a/pkg/cmd/worker/ssh/ssh.go b/pkg/cmd/worker/ssh/ssh.go index 67de1557..5c201e28 100644 --- a/pkg/cmd/worker/ssh/ssh.go +++ b/pkg/cmd/worker/ssh/ssh.go @@ -15,7 +15,7 @@ func NewCmdSsh(f factory.Factory) *cobra.Command { Use: "ssh ", Short: "Manage SSH workers", Long: "Manage SSH workers in Octopus Deploy", - Example: heredoc.Docf("$ %s worker SSH list", constants.ExecutableName), + Example: heredoc.Docf("%s worker SSH list", constants.ExecutableName), } cmd.AddCommand(cmdCreate.NewCmdCreate(f)) diff --git a/pkg/cmd/worker/ssh/view/view.go b/pkg/cmd/worker/ssh/view/view.go index 1dc93021..20a0168f 100644 --- a/pkg/cmd/worker/ssh/view/view.go +++ b/pkg/cmd/worker/ssh/view/view.go @@ -21,8 +21,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a SSH worker", Long: "View a SSH worker in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker ssh view 'linux-worker' - $ %[1]s worker ssh view Machines-100 + %[1]s worker ssh view 'linux-worker' + %[1]s worker ssh view Machines-100 `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { opts := shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c) diff --git a/pkg/cmd/worker/view/view.go b/pkg/cmd/worker/view/view.go index 27a34c08..59489a3c 100644 --- a/pkg/cmd/worker/view/view.go +++ b/pkg/cmd/worker/view/view.go @@ -25,8 +25,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a worker", Long: "View a worker in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker view Machines-100 - $ %[1]s worker view 'worker' + %[1]s worker view Machines-100 + %[1]s worker view 'worker' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { return ViewRun(shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c)) diff --git a/pkg/cmd/worker/worker.go b/pkg/cmd/worker/worker.go index e6be4fa2..6198d173 100644 --- a/pkg/cmd/worker/worker.go +++ b/pkg/cmd/worker/worker.go @@ -20,8 +20,8 @@ func NewCmdWorker(f factory.Factory) *cobra.Command { Short: "Manage workers", Long: "Manage workers in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker list - $ %[1]s worker ls + %[1]s worker list + %[1]s worker ls `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true", diff --git a/pkg/cmd/workerpool/delete/delete.go b/pkg/cmd/workerpool/delete/delete.go index 6116af02..fd5d0ea7 100644 --- a/pkg/cmd/workerpool/delete/delete.go +++ b/pkg/cmd/workerpool/delete/delete.go @@ -2,6 +2,7 @@ package delete import ( "fmt" + "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/workerpools" "github.com/MakeNowJust/heredoc/v2" @@ -39,8 +40,8 @@ func NewCmdDelete(f factory.Factory) *cobra.Command { Long: "Delete a worker pool in Octopus Deploy", Aliases: []string{"del", "rm", "remove"}, Example: heredoc.Docf(` - $ %[1]s worker-pool delete - $ %[1]s worker-pool rm + %[1]s worker-pool delete + %[1]s worker-pool rm `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { deps := cmd.NewDependencies(f, c) diff --git a/pkg/cmd/workerpool/dynamic/create/create.go b/pkg/cmd/workerpool/dynamic/create/create.go index 726b9df4..eab34581 100644 --- a/pkg/cmd/workerpool/dynamic/create/create.go +++ b/pkg/cmd/workerpool/dynamic/create/create.go @@ -2,6 +2,7 @@ package create import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/constants" @@ -67,7 +68,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create a dynamic worker pool", Long: "Create a dynamic worker pool in Octopus Deploy", Example: heredoc.Docf(` - $ %s worker-pool dynamic create + %s worker-pool dynamic create `, constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/workerpool/dynamic/dynamic.go b/pkg/cmd/workerpool/dynamic/dynamic.go index 2f06d217..a9cf74a0 100644 --- a/pkg/cmd/workerpool/dynamic/dynamic.go +++ b/pkg/cmd/workerpool/dynamic/dynamic.go @@ -14,7 +14,7 @@ func NewCmdSsh(f factory.Factory) *cobra.Command { Use: "dynamic ", Short: "Manage dynamic worker pools", Long: "Manage dynamic worker pools in Octopus Deploy", - Example: heredoc.Docf("$ %s worker-pool dynamic view", constants.ExecutableName), + Example: heredoc.Docf("%s worker-pool dynamic view", constants.ExecutableName), } cmd.AddCommand(cmdCreate.NewCmdCreate(f)) diff --git a/pkg/cmd/workerpool/dynamic/view/view.go b/pkg/cmd/workerpool/dynamic/view/view.go index 3edd20e1..599e4145 100644 --- a/pkg/cmd/workerpool/dynamic/view/view.go +++ b/pkg/cmd/workerpool/dynamic/view/view.go @@ -21,8 +21,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a dynamic worker pool", Long: "View a dynamic worker pool in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker-pool dynamic view WorkerPools-3 - $ %[1]s worker-pool dynamic view 'Hosted Workers' + %[1]s worker-pool dynamic view WorkerPools-3 + %[1]s worker-pool dynamic view 'Hosted Workers' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { return ViewRun(shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c)) diff --git a/pkg/cmd/workerpool/list/list.go b/pkg/cmd/workerpool/list/list.go index 50f3e3b1..7ebe38d8 100644 --- a/pkg/cmd/workerpool/list/list.go +++ b/pkg/cmd/workerpool/list/list.go @@ -31,7 +31,7 @@ func NewCmdList(f factory.Factory) *cobra.Command { Short: "List worker pools", Long: "List worker pools in Octopus Deploy", Aliases: []string{"ls"}, - Example: heredoc.Docf("$ %s worker-pool list", constants.ExecutableName), + Example: heredoc.Docf("%s worker-pool list", constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { return ListRun(NewListOptions(cmd.NewDependencies(f, c), c)) }, diff --git a/pkg/cmd/workerpool/static/create/create.go b/pkg/cmd/workerpool/static/create/create.go index 2404ebb9..50ef72c1 100644 --- a/pkg/cmd/workerpool/static/create/create.go +++ b/pkg/cmd/workerpool/static/create/create.go @@ -2,6 +2,7 @@ package create import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/constants" @@ -52,7 +53,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { Short: "Create a static worker pool", Long: "Create a static worker pool in Octopus Deploy", Example: heredoc.Docf(` - $ %s worker-pool static create + %s worker-pool static create `, constants.ExecutableName), RunE: func(c *cobra.Command, _ []string) error { opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) diff --git a/pkg/cmd/workerpool/static/static.go b/pkg/cmd/workerpool/static/static.go index ebfc8f2b..37b11e72 100644 --- a/pkg/cmd/workerpool/static/static.go +++ b/pkg/cmd/workerpool/static/static.go @@ -14,7 +14,7 @@ func NewCmdStatic(f factory.Factory) *cobra.Command { Use: "static ", Short: "Manage static worker pools", Long: "Manage static worker pools in Octopus Deploy", - Example: heredoc.Docf("$ %s worker-pool static view", constants.ExecutableName), + Example: heredoc.Docf("%s worker-pool static view", constants.ExecutableName), } cmd.AddCommand(cmdView.NewCmdView(f)) diff --git a/pkg/cmd/workerpool/static/view/view.go b/pkg/cmd/workerpool/static/view/view.go index 7552c960..643fb247 100644 --- a/pkg/cmd/workerpool/static/view/view.go +++ b/pkg/cmd/workerpool/static/view/view.go @@ -2,6 +2,7 @@ package view import ( "fmt" + "github.com/MakeNowJust/heredoc/v2" "github.com/OctopusDeploy/cli/pkg/cmd" "github.com/OctopusDeploy/cli/pkg/cmd/workerpool/shared" @@ -24,8 +25,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a static worker pool", Long: "View a static worker pool in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker-pool static view WorkerPools-3 - $ %[1]s worker-pool static view 'windows workers' + %[1]s worker-pool static view WorkerPools-3 + %[1]s worker-pool static view 'windows workers' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { return ViewRun(shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c)) diff --git a/pkg/cmd/workerpool/view/view.go b/pkg/cmd/workerpool/view/view.go index 3b61fe01..948e3b19 100644 --- a/pkg/cmd/workerpool/view/view.go +++ b/pkg/cmd/workerpool/view/view.go @@ -26,8 +26,8 @@ func NewCmdView(f factory.Factory) *cobra.Command { Short: "View a worker pool", Long: "View a worker pool in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker-pool view WorkerPools-3 - $ %[1]s worker-pool view 'linux workers' + %[1]s worker-pool view WorkerPools-3 + %[1]s worker-pool view 'linux workers' `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { return ViewRun(shared.NewViewOptions(flags, cmd.NewDependencies(f, c), args, c)) @@ -217,5 +217,3 @@ func calculateWorkerStats(workers []*machines.Worker) WorkerStats { return stats } - - diff --git a/pkg/cmd/workerpool/workerpool.go b/pkg/cmd/workerpool/workerpool.go index bfee6f67..36f7df33 100644 --- a/pkg/cmd/workerpool/workerpool.go +++ b/pkg/cmd/workerpool/workerpool.go @@ -19,8 +19,8 @@ func NewCmdWorkerPool(f factory.Factory) *cobra.Command { Short: "Manage worker pools", Long: "Manage worker pools in Octopus Deploy", Example: heredoc.Docf(` - $ %[1]s worker-pool list - $ %[1]s worker-pool ls + %[1]s worker-pool list + %[1]s worker-pool ls `, constants.ExecutableName), Annotations: map[string]string{ annotations.IsCore: "true",