From 9625129a15fe5f56a95f200abdfe3b2198b8d322 Mon Sep 17 00:00:00 2001 From: nikhilsbhat Date: Fri, 22 Dec 2023 21:57:50 +0530 Subject: [PATCH] Remove flag pipeline name from registerPipelineFlags --- cmd/flags.go | 14 ++++++-------- cmd/pipelines.go | 19 +++++++++---------- docs/doc/gocd-cli_pipeline_action.md | 1 - docs/doc/gocd-cli_pipeline_comment.md | 1 - docs/doc/gocd-cli_pipeline_create.md | 1 - docs/doc/gocd-cli_pipeline_instance.md | 1 - docs/doc/gocd-cli_pipeline_schedule.md | 3 +-- docs/doc/gocd-cli_pipeline_template.md | 1 - docs/doc/gocd-cli_pipeline_update.md | 1 - 9 files changed, 16 insertions(+), 26 deletions(-) diff --git a/cmd/flags.go b/cmd/flags.go index e54e66e..fcd5ba2 100644 --- a/cmd/flags.go +++ b/cmd/flags.go @@ -11,6 +11,12 @@ var ( jsonQuery string ) +const ( + defaultRetryCount = 30 + defaultDelay = 5 * time.Second + defaultInstanceCount = 0 +) + func registerGlobalFlags(cmd *cobra.Command) { cmd.PersistentFlags().StringVarP(&cliCfg.URL, "server-url", "", "http://localhost:8153/go", "GoCD server URL base path") @@ -80,12 +86,6 @@ func commonPluginFlags(cmd *cobra.Command) { "setting this would set 'plugin-id' to 'yaml.config.plugin'") } -const ( - defaultRetryCount = 30 - defaultDelay = 5 * time.Second - defaultInstanceCount = 0 -) - func registerBackupFlags(cmd *cobra.Command) { cmd.PersistentFlags().IntVarP(&backupRetry, "retry", "", defaultRetryCount, "number of times to retry to get backup stats when backup status is not ready") @@ -96,8 +96,6 @@ func registerBackupFlags(cmd *cobra.Command) { func registerPipelineFlags(cmd *cobra.Command) { cmd.PersistentFlags().IntVarP(&goCDPipelineInstance, "instance", "i", defaultInstanceCount, "instance number of a pipeline") - cmd.PersistentFlags().StringVarP(&goCDPipelineName, "name", "n", "", - "name of the pipeline present in GoCD") cmd.PersistentFlags().StringVarP(&goCDPipelineETAG, "etag", "", "", "etag used to identify the pipeline config. If you don't have one get it by using pipeline get command") cmd.PersistentFlags().StringVarP(&goCDPipelineMessage, "message", "m", "", diff --git a/cmd/pipelines.go b/cmd/pipelines.go index f62b202..d2e7d34 100644 --- a/cmd/pipelines.go +++ b/cmd/pipelines.go @@ -25,7 +25,6 @@ var ( toCSV string rawOutput bool goCDPipelineInstance int - goCDPipelineName string goCDPipelineMessage string goCDPipelineETAG string goCDPipelineTemplateName string @@ -80,7 +79,7 @@ GET/PAUSE/UNPAUSE/UNLOCK/SCHEDULE and comment on a GoCD pipeline`, pipelineCommand.AddCommand(exportPipelineToConfigRepoFormatCommand()) pipelineCommand.AddCommand(getPipelineVSMCommand()) pipelineCommand.AddCommand(getPipelineMapping()) - pipelineCommand.AddCommand(getPipelineFilesCommand()) + pipelineCommand.AddCommand(findPipelineFilesCommand()) pipelineCommand.AddCommand(showPipelineCommand()) for _, command := range pipelineCommand.Commands() { @@ -700,9 +699,9 @@ func schedulePipelineCommand() *cobra.Command { schedulePipelineCmd := &cobra.Command{ Use: "schedule", Short: "Command to SCHEDULE a specific pipeline present in GoCD [https://api.gocd.org/current/#scheduling-pipelines]", - Args: cobra.NoArgs, + Args: cobra.RangeArgs(1, 1), PreRunE: setCLIClient, - Example: `gocd-cli pipeline schedule --name sample --from-file schedule-config.yaml`, + Example: `gocd-cli pipeline schedule sample --from-file schedule-config.yaml`, RunE: func(cmd *cobra.Command, args []string) error { var schedule gocd.Schedule object, err := readObject(cmd) @@ -723,11 +722,11 @@ func schedulePipelineCommand() *cobra.Command { return &errors.UnknownObjectTypeError{Name: objType} } - if err = client.SchedulePipeline(goCDPipelineName, schedule); err != nil { + if err = client.SchedulePipeline(args[0], schedule); err != nil { return err } - return cliRenderer.Render(fmt.Sprintf("pipeline '%s' scheduled successfully", goCDPipelineName)) + return cliRenderer.Render(fmt.Sprintf("pipeline '%s' scheduled successfully", args[0])) }, } @@ -740,12 +739,12 @@ func commentPipelineCommand() *cobra.Command { commentOnPipelineCmd := &cobra.Command{ Use: "comment", Short: "Command to COMMENT on a specific pipeline instance present in GoCD [https://api.gocd.org/current/#comment-on-pipeline-instance]", - Args: cobra.NoArgs, + Args: cobra.RangeArgs(1, 1), PreRunE: setCLIClient, Example: `gocd-cli pipeline comment --message "message to be commented"`, RunE: func(cmd *cobra.Command, args []string) error { pipelineObject := gocd.PipelineObject{ - Name: goCDPipelineName, + Name: args[0], Counter: goCDPipelineInstance, Message: goCDPipelineMessage, } @@ -754,7 +753,7 @@ func commentPipelineCommand() *cobra.Command { return err } - return cliRenderer.Render(fmt.Sprintf("commented on pipeline '%s' successfully", goCDPipelineName)) + return cliRenderer.Render(fmt.Sprintf("commented on pipeline '%s' successfully", args[0])) }, } @@ -1064,7 +1063,7 @@ func getPipelineMapping() *cobra.Command { return getPipelineMappingCmd } -func getPipelineFilesCommand() *cobra.Command { +func findPipelineFilesCommand() *cobra.Command { var ( goCDPipelinesPath string goCDPipelinesPatterns []string diff --git a/docs/doc/gocd-cli_pipeline_action.md b/docs/doc/gocd-cli_pipeline_action.md index 0b1e973..5461433 100644 --- a/docs/doc/gocd-cli_pipeline_action.md +++ b/docs/doc/gocd-cli_pipeline_action.md @@ -20,7 +20,6 @@ gocd-cli pipeline action sample-pipeline --pause/--un-pause -h, --help help for action -i, --instance int instance number of a pipeline -m, --message string message to be passed while pausing/unpausing or commenting on pipeline present in GoCD - -n, --name string name of the pipeline present in GoCD --pause enable to pause a pipeline --pause-at-start enabling this will create the pipeline in the paused state --template-name string name of the template to which the pipeline has to be extracted diff --git a/docs/doc/gocd-cli_pipeline_comment.md b/docs/doc/gocd-cli_pipeline_comment.md index cc028fb..b045fa1 100644 --- a/docs/doc/gocd-cli_pipeline_comment.md +++ b/docs/doc/gocd-cli_pipeline_comment.md @@ -19,7 +19,6 @@ gocd-cli pipeline comment --message "message to be commented" -h, --help help for comment -i, --instance int instance number of a pipeline -m, --message string message to be passed while pausing/unpausing or commenting on pipeline present in GoCD - -n, --name string name of the pipeline present in GoCD --pause enable to pause a pipeline --pause-at-start enabling this will create the pipeline in the paused state --template-name string name of the template to which the pipeline has to be extracted diff --git a/docs/doc/gocd-cli_pipeline_create.md b/docs/doc/gocd-cli_pipeline_create.md index 69e66a4..644b5c2 100644 --- a/docs/doc/gocd-cli_pipeline_create.md +++ b/docs/doc/gocd-cli_pipeline_create.md @@ -20,7 +20,6 @@ gocd-cli pipeline create sample-pipeline --from-file sample-pipeline.yaml --log- -h, --help help for create -i, --instance int instance number of a pipeline -m, --message string message to be passed while pausing/unpausing or commenting on pipeline present in GoCD - -n, --name string name of the pipeline present in GoCD --pause enable to pause a pipeline --pause-at-start enabling this will create the pipeline in the paused state --template-name string name of the template to which the pipeline has to be extracted diff --git a/docs/doc/gocd-cli_pipeline_instance.md b/docs/doc/gocd-cli_pipeline_instance.md index 8d2f741..74cfc24 100644 --- a/docs/doc/gocd-cli_pipeline_instance.md +++ b/docs/doc/gocd-cli_pipeline_instance.md @@ -19,7 +19,6 @@ gocd-cli pipeline instance sample-pipeline --instance 10 -h, --help help for instance -i, --instance int instance number of a pipeline -m, --message string message to be passed while pausing/unpausing or commenting on pipeline present in GoCD - -n, --name string name of the pipeline present in GoCD --pause enable to pause a pipeline --pause-at-start enabling this will create the pipeline in the paused state --template-name string name of the template to which the pipeline has to be extracted diff --git a/docs/doc/gocd-cli_pipeline_schedule.md b/docs/doc/gocd-cli_pipeline_schedule.md index b1f696f..797ebaf 100644 --- a/docs/doc/gocd-cli_pipeline_schedule.md +++ b/docs/doc/gocd-cli_pipeline_schedule.md @@ -9,7 +9,7 @@ gocd-cli pipeline schedule [flags] ### Examples ``` -gocd-cli pipeline schedule --name sample --from-file schedule-config.yaml +gocd-cli pipeline schedule sample --from-file schedule-config.yaml ``` ### Options @@ -19,7 +19,6 @@ gocd-cli pipeline schedule --name sample --from-file schedule-config.yaml -h, --help help for schedule -i, --instance int instance number of a pipeline -m, --message string message to be passed while pausing/unpausing or commenting on pipeline present in GoCD - -n, --name string name of the pipeline present in GoCD --pause enable to pause a pipeline --pause-at-start enabling this will create the pipeline in the paused state --template-name string name of the template to which the pipeline has to be extracted diff --git a/docs/doc/gocd-cli_pipeline_template.md b/docs/doc/gocd-cli_pipeline_template.md index 89ec0a0..c3f5811 100644 --- a/docs/doc/gocd-cli_pipeline_template.md +++ b/docs/doc/gocd-cli_pipeline_template.md @@ -19,7 +19,6 @@ gocd-cli pipeline template --name sample-pipeline --template-name sample-templat -h, --help help for template -i, --instance int instance number of a pipeline -m, --message string message to be passed while pausing/unpausing or commenting on pipeline present in GoCD - -n, --name string name of the pipeline present in GoCD --pause enable to pause a pipeline --pause-at-start enabling this will create the pipeline in the paused state --template-name string name of the template to which the pipeline has to be extracted diff --git a/docs/doc/gocd-cli_pipeline_update.md b/docs/doc/gocd-cli_pipeline_update.md index 68c2062..5986700 100644 --- a/docs/doc/gocd-cli_pipeline_update.md +++ b/docs/doc/gocd-cli_pipeline_update.md @@ -20,7 +20,6 @@ gocd-cli pipeline update sample-movies --from-file sample-movies.yaml --log-leve -h, --help help for update -i, --instance int instance number of a pipeline -m, --message string message to be passed while pausing/unpausing or commenting on pipeline present in GoCD - -n, --name string name of the pipeline present in GoCD --pause enable to pause a pipeline --pause-at-start enabling this will create the pipeline in the paused state --template-name string name of the template to which the pipeline has to be extracted