From 8793b01d26e7c9a6d6dffd5e755ff9fa2ada79cb Mon Sep 17 00:00:00 2001 From: nikhilsbhat Date: Tue, 21 Mar 2023 23:07:09 +0530 Subject: [PATCH] Add support to GET/CREATE/UPDATE/DELETE pipeline config Add support to get list of scheduled jobs Reorganize the flags for subcommand pipeline --- cmd/commands.go | 1 + cmd/flags.go | 6 + cmd/jobs.go | 54 +++++ cmd/pipelines.go | 210 +++++++++++++++++- docs/doc/gocd-cli.md | 5 +- docs/doc/gocd-cli_agents.md | 2 +- docs/doc/gocd-cli_agents_delete.md | 2 +- docs/doc/gocd-cli_agents_get-all.md | 2 +- docs/doc/gocd-cli_agents_get.md | 2 +- docs/doc/gocd-cli_agents_job-history.md | 2 +- docs/doc/gocd-cli_agents_kill-task.md | 2 +- docs/doc/gocd-cli_agents_list.md | 2 +- docs/doc/gocd-cli_agents_update.md | 2 +- docs/doc/gocd-cli_backup.md | 2 +- docs/doc/gocd-cli_backup_create-config.md | 2 +- docs/doc/gocd-cli_backup_delete-config.md | 2 +- docs/doc/gocd-cli_backup_get-config.md | 2 +- docs/doc/gocd-cli_backup_schedule.md | 2 +- docs/doc/gocd-cli_backup_stats.md | 2 +- docs/doc/gocd-cli_cluster-profile.md | 2 +- docs/doc/gocd-cli_cluster-profile_create.md | 2 +- docs/doc/gocd-cli_cluster-profile_delete.md | 2 +- docs/doc/gocd-cli_cluster-profile_get-all.md | 2 +- docs/doc/gocd-cli_cluster-profile_get.md | 2 +- docs/doc/gocd-cli_cluster-profile_list.md | 2 +- docs/doc/gocd-cli_cluster-profile_update.md | 2 +- docs/doc/gocd-cli_configrepo.md | 2 +- docs/doc/gocd-cli_configrepo_create.md | 2 +- docs/doc/gocd-cli_configrepo_delete.md | 2 +- docs/doc/gocd-cli_configrepo_get-all.md | 2 +- docs/doc/gocd-cli_configrepo_get.md | 2 +- docs/doc/gocd-cli_configrepo_list.md | 2 +- .../gocd-cli_configrepo_preflight-check.md | 2 +- docs/doc/gocd-cli_configrepo_status.md | 2 +- .../doc/gocd-cli_configrepo_trigger-update.md | 2 +- docs/doc/gocd-cli_configrepo_update.md | 2 +- docs/doc/gocd-cli_elastic-agent-profile.md | 2 +- .../gocd-cli_elastic-agent-profile_create.md | 2 +- .../gocd-cli_elastic-agent-profile_delete.md | 2 +- .../gocd-cli_elastic-agent-profile_get-all.md | 2 +- .../doc/gocd-cli_elastic-agent-profile_get.md | 2 +- .../gocd-cli_elastic-agent-profile_list.md | 2 +- .../gocd-cli_elastic-agent-profile_update.md | 2 +- docs/doc/gocd-cli_encryption.md | 2 +- docs/doc/gocd-cli_encryption_decrypt.md | 2 +- docs/doc/gocd-cli_encryption_encrypt.md | 2 +- docs/doc/gocd-cli_environment.md | 2 +- docs/doc/gocd-cli_environment_create.md | 2 +- docs/doc/gocd-cli_environment_delete.md | 2 +- docs/doc/gocd-cli_environment_get-all.md | 2 +- docs/doc/gocd-cli_environment_get.md | 2 +- docs/doc/gocd-cli_environment_list.md | 2 +- docs/doc/gocd-cli_environment_patch.md | 2 +- docs/doc/gocd-cli_environment_update.md | 2 +- docs/doc/gocd-cli_job.md | 46 ++++ docs/doc/gocd-cli_job_scheduled.md | 53 +++++ docs/doc/gocd-cli_maintenance.md | 2 +- docs/doc/gocd-cli_maintenance_action.md | 2 +- docs/doc/gocd-cli_maintenance_get.md | 2 +- docs/doc/gocd-cli_pipeline-group.md | 2 +- docs/doc/gocd-cli_pipeline-group_create.md | 2 +- docs/doc/gocd-cli_pipeline-group_delete.md | 2 +- docs/doc/gocd-cli_pipeline-group_get-all.md | 2 +- docs/doc/gocd-cli_pipeline-group_get.md | 2 +- docs/doc/gocd-cli_pipeline-group_list.md | 2 +- docs/doc/gocd-cli_pipeline-group_update.md | 2 +- docs/doc/gocd-cli_pipeline.md | 18 +- docs/doc/gocd-cli_pipeline_action.md | 19 +- docs/doc/gocd-cli_pipeline_comment.md | 19 +- docs/doc/gocd-cli_pipeline_create.md | 54 +++++ docs/doc/gocd-cli_pipeline_delete.md | 45 ++++ docs/doc/gocd-cli_pipeline_get-all.md | 9 +- docs/doc/gocd-cli_pipeline_get.md | 45 ++++ docs/doc/gocd-cli_pipeline_instance.md | 19 +- docs/doc/gocd-cli_pipeline_list.md | 9 +- docs/doc/gocd-cli_pipeline_schedule.md | 19 +- docs/doc/gocd-cli_pipeline_status.md | 9 +- docs/doc/gocd-cli_pipeline_template.md | 53 +++++ docs/doc/gocd-cli_pipeline_update.md | 54 +++++ docs/doc/gocd-cli_plugin.md | 2 +- docs/doc/gocd-cli_plugin_create-settings.md | 2 +- docs/doc/gocd-cli_plugin_get-info-all.md | 2 +- docs/doc/gocd-cli_plugin_get-info.md | 2 +- docs/doc/gocd-cli_plugin_get-settings.md | 2 +- docs/doc/gocd-cli_plugin_list.md | 2 +- docs/doc/gocd-cli_plugin_update-settings.md | 2 +- docs/doc/gocd-cli_server.md | 2 +- docs/doc/gocd-cli_server_health-messages.md | 2 +- docs/doc/gocd-cli_server_health.md | 2 +- docs/doc/gocd-cli_user.md | 2 +- docs/doc/gocd-cli_user_create.md | 2 +- docs/doc/gocd-cli_user_delete-bulk.md | 2 +- docs/doc/gocd-cli_user_delete.md | 2 +- docs/doc/gocd-cli_user_get-all.md | 2 +- docs/doc/gocd-cli_user_get.md | 2 +- docs/doc/gocd-cli_user_update.md | 2 +- docs/doc/gocd-cli_version.md | 2 +- go.mod | 2 +- go.sum | 4 +- 99 files changed, 754 insertions(+), 153 deletions(-) create mode 100644 cmd/jobs.go create mode 100644 docs/doc/gocd-cli_job.md create mode 100644 docs/doc/gocd-cli_job_scheduled.md create mode 100644 docs/doc/gocd-cli_pipeline_create.md create mode 100644 docs/doc/gocd-cli_pipeline_delete.md create mode 100644 docs/doc/gocd-cli_pipeline_get.md create mode 100644 docs/doc/gocd-cli_pipeline_template.md create mode 100644 docs/doc/gocd-cli_pipeline_update.md diff --git a/cmd/commands.go b/cmd/commands.go index 14fbfbb..06154de 100644 --- a/cmd/commands.go +++ b/cmd/commands.go @@ -45,6 +45,7 @@ func getGoCDCliCommands() *cobra.Command { command.commands = append(command.commands, registerPipelineGroupsCommand()) command.commands = append(command.commands, registerPipelinesCommand()) command.commands = append(command.commands, registerMaintenanceCommand()) + command.commands = append(command.commands, registerJobsCommand()) return command.prepareCommands() } diff --git a/cmd/flags.go b/cmd/flags.go index 1ce3f8a..c1a96ec 100644 --- a/cmd/flags.go +++ b/cmd/flags.go @@ -81,12 +81,18 @@ func registerPipelineFlags(cmd *cobra.Command) { "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", "", "message to be passed while pausing/unpausing or commenting on pipeline present in GoCD") cmd.PersistentFlags().BoolVarP(&goCDPipelinePause, "pause", "", false, "enable to pause a pipeline") cmd.PersistentFlags().BoolVarP(&goCDPipelineUnPause, "un-pause", "", false, "disable to pause a pipeline") + cmd.PersistentFlags().BoolVarP(&goCDPausePipelineAtStart, "pause-at-start", "", false, + "enabling this will create the pipeline in the paused state") + cmd.PersistentFlags().StringVarP(&goCDPipelineTemplateName, "template-name", "", "", + "name of the template to which the pipeline has to be extracted") } func registerMaintenanceFlags(cmd *cobra.Command) { diff --git a/cmd/jobs.go b/cmd/jobs.go new file mode 100644 index 0000000..cb859b1 --- /dev/null +++ b/cmd/jobs.go @@ -0,0 +1,54 @@ +package cmd + +import ( + "github.com/spf13/cobra" +) + +func registerJobsCommand() *cobra.Command { + jobsCommand := &cobra.Command{ + Use: "job", + Short: "Command to operate on jobs present in GoCD", + Long: `Command leverages GoCD job apis' +[https://api.gocd.org/current/#scheduled-jobs] to +GET/SCHEDULE jobs of specific pipelines present GoCD`, + RunE: func(cmd *cobra.Command, args []string) error { + if err := cmd.Usage(); err != nil { + return err + } + + return nil + }, + } + + jobsCommand.SetUsageTemplate(getUsageTemplate()) + + jobsCommand.AddCommand(getScheduledJobsCommand()) + + for _, command := range jobsCommand.Commands() { + command.SilenceUsage = true + } + + return jobsCommand +} + +func getScheduledJobsCommand() *cobra.Command { + getScheduledJobsCmd := &cobra.Command{ + Use: "scheduled", + Short: "Command to GET a list of scheduled jobs in GoCD [https://api.gocd.org/current/#scheduled-jobs]", + Args: cobra.NoArgs, + PreRunE: setCLIClient, + Example: `gocd-cli job scheduled"`, + RunE: func(cmd *cobra.Command, args []string) error { + response, err := client.GetScheduledJobs() + if err != nil { + return err + } + + return cliRenderer.Render(response) + }, + } + + registerPipelineFlags(getScheduledJobsCmd) + + return getScheduledJobsCmd +} diff --git a/cmd/pipelines.go b/cmd/pipelines.go index 3ce6de2..8f1bee5 100644 --- a/cmd/pipelines.go +++ b/cmd/pipelines.go @@ -13,18 +13,21 @@ import ( ) var ( - goCDPipelineInstance int - goCDPipelineName string - goCDPipelineMessage string - goCDPipelinePause bool - goCDPipelineUnPause bool + goCDPipelineInstance int + goCDPipelineName string + goCDPipelineMessage string + goCDPipelineETAG string + goCDPipelineTemplateName string + goCDPausePipelineAtStart bool + goCDPipelinePause bool + goCDPipelineUnPause bool ) func registerPipelinesCommand() *cobra.Command { pipelineCommand := &cobra.Command{ Use: "pipeline", - Short: "Command to operate on pipelines present in GoCD ", - Long: `Command leverages GoCD pipeline group config apis' + Short: "Command to operate on pipelines present in GoCD", + Long: `Command leverages GoCD pipeline apis' [https://api.gocd.org/current/#pipeline-instances, https://api.gocd.org/current/#pipeline-config, https://api.gocd.org/current/#pipelines] to GET/PAUSE/UNPAUSE/UNLOCK/SCHEDULE and comment on a GoCD pipeline`, RunE: func(cmd *cobra.Command, args []string) error { @@ -38,14 +41,17 @@ GET/PAUSE/UNPAUSE/UNLOCK/SCHEDULE and comment on a GoCD pipeline`, pipelineCommand.SetUsageTemplate(getUsageTemplate()) - registerPipelineFlags(pipelineCommand) - pipelineCommand.AddCommand(getPipelinesCommand()) + pipelineCommand.AddCommand(getPipelineCommand()) + pipelineCommand.AddCommand(createPipelineCommand()) + pipelineCommand.AddCommand(updatePipelineCommand()) + pipelineCommand.AddCommand(deletePipelineCommand()) pipelineCommand.AddCommand(getPipelineStateCommand()) pipelineCommand.AddCommand(getPipelineInstanceCommand()) pipelineCommand.AddCommand(pauseUnpausePipelineCommand()) pipelineCommand.AddCommand(schedulePipelineCommand()) pipelineCommand.AddCommand(commentPipelineCommand()) + pipelineCommand.AddCommand(pipelineExtractTemplateCommand()) pipelineCommand.AddCommand(listPipelinesCommand()) for _, command := range pipelineCommand.Commands() { @@ -88,6 +94,162 @@ func getPipelinesCommand() *cobra.Command { return getPipelinesCmd } +func getPipelineCommand() *cobra.Command { + getPipelineCmd := &cobra.Command{ + Use: "get", + Short: "Command to GET pipeline config of a specified pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-config", + Args: cobra.RangeArgs(1, 1), + PreRunE: setCLIClient, + Example: `gocd-cli pipeline get sample-pipeline --query "[*] | name eq sample-group"`, + RunE: func(cmd *cobra.Command, args []string) error { + response, err := client.GetPipelineConfig(args[0]) + if err != nil { + return err + } + + if len(jsonQuery) != 0 { + cliLogger.Debugf(queryEnabledMessage, jsonQuery) + + baseQuery, err := render.SetQuery(response, jsonQuery) + if err != nil { + return err + } + + cliLogger.Debugf(baseQuery.Print()) + + return cliRenderer.Render(baseQuery.RunQuery()) + } + + return cliRenderer.Render(response) + }, + } + + return getPipelineCmd +} + +func createPipelineCommand() *cobra.Command { + createPipelineGroupCmd := &cobra.Command{ + Use: "create", + Short: "Command to CREATE the pipeline with all specified configuration [https://api.gocd.org/current/#create-a-pipeline]", + Args: cobra.NoArgs, + PreRunE: setCLIClient, + Example: `gocd-cli pipeline create sample-pipeline --from-file sample-pipeline.yaml --log-level debug +// the inputs can be passed either from file using '--from-file' flag or entire content as argument to command`, + RunE: func(cmd *cobra.Command, args []string) error { + var pipeline map[string]interface{} + object, err := readObject(cmd) + if err != nil { + return err + } + + switch objType := object.CheckFileType(cliLogger); objType { + case render.FileTypeYAML: + if err = yaml.Unmarshal([]byte(object), &pipeline); err != nil { + return err + } + case render.FileTypeJSON: + if err = json.Unmarshal([]byte(object), &pipeline); err != nil { + return err + } + default: + return &errors.UnknownObjectTypeError{Name: objType} + } + + pipelineConfig := gocd.PipelineConfig{ + Config: pipeline, + } + + if goCDPausePipelineAtStart { + pipelineConfig.PausePipeline = true + } + + if len(goCDPipelineMessage) != 0 { + pipelineConfig.PauseReason = goCDPipelineMessage + } + + if err = client.CreatePipeline(pipelineConfig); err != nil { + return err + } + + return cliRenderer.Render(fmt.Sprintf("pipeline %s created successfully", pipeline["name"])) + }, + } + + registerPipelineFlags(createPipelineGroupCmd) + + return createPipelineGroupCmd +} + +func updatePipelineCommand() *cobra.Command { + updatePipelineGroupCmd := &cobra.Command{ + Use: "update", + Short: "Command to UPDATE the pipeline config with the latest specified configuration [https://api.gocd.org/current/#edit-pipeline-config]", + Args: cobra.NoArgs, + PreRunE: setCLIClient, + Example: `gocd-cli pipeline update sample-movies --from-file sample-movies.yaml --log-level debug +// the inputs can be passed either from file using '--from-file' flag or entire content as argument to command`, + RunE: func(cmd *cobra.Command, args []string) error { + var pipeline map[string]interface{} + object, err := readObject(cmd) + if err != nil { + return err + } + + switch objType := object.CheckFileType(cliLogger); objType { + case render.FileTypeYAML: + if err = yaml.Unmarshal([]byte(object), &pipeline); err != nil { + return err + } + case render.FileTypeJSON: + if err = json.Unmarshal([]byte(object), &pipeline); err != nil { + return err + } + default: + return &errors.UnknownObjectTypeError{Name: objType} + } + + pipelineConfig := gocd.PipelineConfig{ + ETAG: goCDPipelineETAG, + Config: pipeline, + } + + response, err := client.UpdatePipelineConfig(pipelineConfig) + if err != nil { + return err + } + + if err = cliRenderer.Render(fmt.Sprintf("pipeline %s updated successfully", pipeline["name"])); err != nil { + return err + } + + return cliRenderer.Render(response) + }, + } + + registerPipelineFlags(updatePipelineGroupCmd) + + return updatePipelineGroupCmd +} + +func deletePipelineCommand() *cobra.Command { + deletePipelineCmd := &cobra.Command{ + Use: "delete", + Short: "Command to DELETE the specified pipeline from GoCD [https://api.gocd.org/current/#delete-a-pipeline]", + Args: cobra.RangeArgs(1, 1), + PreRunE: setCLIClient, + Example: `gocd-cli pipeline delete movies`, + RunE: func(cmd *cobra.Command, args []string) error { + if err := client.DeletePipeline(args[0]); err != nil { + return err + } + + return cliRenderer.Render(fmt.Sprintf("pipeline deleted: %s", args[0])) + }, + } + + return deletePipelineCmd +} + func getPipelineStateCommand() *cobra.Command { getPipelineStateCmd := &cobra.Command{ Use: "status", @@ -156,6 +318,8 @@ func getPipelineInstanceCommand() *cobra.Command { }, } + registerPipelineFlags(getPipelineInstanceCmd) + return getPipelineInstanceCmd } @@ -186,6 +350,8 @@ func pauseUnpausePipelineCommand() *cobra.Command { }, } + registerPipelineFlags(pauseUnpausePipelineCmd) + return pauseUnpausePipelineCmd } @@ -224,6 +390,8 @@ func schedulePipelineCommand() *cobra.Command { }, } + registerPipelineFlags(schedulePipelineCmd) + return schedulePipelineCmd } @@ -249,9 +417,33 @@ func commentPipelineCommand() *cobra.Command { }, } + registerPipelineFlags(commentOnPipelineCmd) + return commentOnPipelineCmd } +func pipelineExtractTemplateCommand() *cobra.Command { + extractTemplatePipelineCmd := &cobra.Command{ + Use: "template", + Short: "Command to EXTRACT template from specific pipeline instance present in GoCD [https://api.gocd.org/current/#extract-template-from-pipeline]", + Args: cobra.RangeArgs(1, 1), + PreRunE: setCLIClient, + Example: `gocd-cli pipeline template --name sample-pipeline --template-name sample-template`, + RunE: func(cmd *cobra.Command, args []string) error { + response, err := client.ExtractTemplatePipeline(args[0], goCDPipelineTemplateName) + if err != nil { + return err + } + + return cliRenderer.Render(response) + }, + } + + registerPipelineFlags(extractTemplatePipelineCmd) + + return extractTemplatePipelineCmd +} + func listPipelinesCommand() *cobra.Command { listPipelinesCmd := &cobra.Command{ Use: "list", diff --git a/docs/doc/gocd-cli.md b/docs/doc/gocd-cli.md index 42ded75..6869ca3 100644 --- a/docs/doc/gocd-cli.md +++ b/docs/doc/gocd-cli.md @@ -40,12 +40,13 @@ gocd-cli [flags] * [gocd-cli elastic-agent-profile](gocd-cli_elastic-agent-profile.md) - Command to operate on elastic-agent-profile in GoCD [https://api.gocd.org/current/#elastic-agent-profiles] * [gocd-cli encryption](gocd-cli_encryption.md) - Command to encrypt/decrypt plain text value [https://api.gocd.org/current/#encryption] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] +* [gocd-cli job](gocd-cli_job.md) - Command to operate on jobs present in GoCD * [gocd-cli maintenance](gocd-cli_maintenance.md) - Command to operate on maintenance modes in GoCD [https://api.gocd.org/current/#maintenance-mode] -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD * [gocd-cli pipeline-group](gocd-cli_pipeline-group.md) - Command to operate on pipeline groups present in GoCD [https://api.gocd.org/current/#pipeline-group-config] * [gocd-cli plugin](gocd-cli_plugin.md) - Command to operate on plugins present in GoCD * [gocd-cli server](gocd-cli_server.md) - Command to operate on GoCD server health status * [gocd-cli user](gocd-cli_user.md) - Command to operate on users in GoCD [https://api.gocd.org/current/#users] * [gocd-cli version](gocd-cli_version.md) - Command to fetch the version of gocd-cli installed -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents.md b/docs/doc/gocd-cli_agents.md index 8164455..2484ba5 100644 --- a/docs/doc/gocd-cli_agents.md +++ b/docs/doc/gocd-cli_agents.md @@ -48,4 +48,4 @@ gocd-cli agents [flags] * [gocd-cli agents list](gocd-cli_agents_list.md) - Command to LIST all the agents present in GoCD [https://api.gocd.org/current/#get-all-agents] * [gocd-cli agents update](gocd-cli_agents_update.md) - Command to UPDATE an agent with all specified configuration [https://api.gocd.org/current/#update-an-agent] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents_delete.md b/docs/doc/gocd-cli_agents_delete.md index 593a29e..c7e0ec8 100644 --- a/docs/doc/gocd-cli_agents_delete.md +++ b/docs/doc/gocd-cli_agents_delete.md @@ -36,4 +36,4 @@ gocd-cli agents delete [flags] * [gocd-cli agents](gocd-cli_agents.md) - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents_get-all.md b/docs/doc/gocd-cli_agents_get-all.md index a0f77e7..dcfd2a0 100644 --- a/docs/doc/gocd-cli_agents_get-all.md +++ b/docs/doc/gocd-cli_agents_get-all.md @@ -36,4 +36,4 @@ gocd-cli agents get-all [flags] * [gocd-cli agents](gocd-cli_agents.md) - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents_get.md b/docs/doc/gocd-cli_agents_get.md index 0846727..6c593ac 100644 --- a/docs/doc/gocd-cli_agents_get.md +++ b/docs/doc/gocd-cli_agents_get.md @@ -36,4 +36,4 @@ gocd-cli agents get [flags] * [gocd-cli agents](gocd-cli_agents.md) - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents_job-history.md b/docs/doc/gocd-cli_agents_job-history.md index c55e004..f9e32bc 100644 --- a/docs/doc/gocd-cli_agents_job-history.md +++ b/docs/doc/gocd-cli_agents_job-history.md @@ -36,4 +36,4 @@ gocd-cli agents job-history [flags] * [gocd-cli agents](gocd-cli_agents.md) - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents_kill-task.md b/docs/doc/gocd-cli_agents_kill-task.md index e40ffc6..70e43de 100644 --- a/docs/doc/gocd-cli_agents_kill-task.md +++ b/docs/doc/gocd-cli_agents_kill-task.md @@ -36,4 +36,4 @@ gocd-cli agents kill-task [flags] * [gocd-cli agents](gocd-cli_agents.md) - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents_list.md b/docs/doc/gocd-cli_agents_list.md index c73f29a..198e516 100644 --- a/docs/doc/gocd-cli_agents_list.md +++ b/docs/doc/gocd-cli_agents_list.md @@ -36,4 +36,4 @@ gocd-cli agents list [flags] * [gocd-cli agents](gocd-cli_agents.md) - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_agents_update.md b/docs/doc/gocd-cli_agents_update.md index 2fba8cd..6940e1a 100644 --- a/docs/doc/gocd-cli_agents_update.md +++ b/docs/doc/gocd-cli_agents_update.md @@ -36,4 +36,4 @@ gocd-cli agents update [flags] * [gocd-cli agents](gocd-cli_agents.md) - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_backup.md b/docs/doc/gocd-cli_backup.md index c276983..c3eff88 100644 --- a/docs/doc/gocd-cli_backup.md +++ b/docs/doc/gocd-cli_backup.md @@ -48,4 +48,4 @@ gocd-cli backup [flags] * [gocd-cli backup schedule](gocd-cli_backup_schedule.md) - Command to SCHEDULE backups in GoCD [https://api.gocd.org/current/#schedule-backup] * [gocd-cli backup stats](gocd-cli_backup_stats.md) - Command to GET stats of the specific backup taken in GoCD [https://api.gocd.org/current/#get-backup] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_backup_create-config.md b/docs/doc/gocd-cli_backup_create-config.md index 79b20e5..515671e 100644 --- a/docs/doc/gocd-cli_backup_create-config.md +++ b/docs/doc/gocd-cli_backup_create-config.md @@ -38,4 +38,4 @@ gocd-cli backup create-config [flags] * [gocd-cli backup](gocd-cli_backup.md) - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_backup_delete-config.md b/docs/doc/gocd-cli_backup_delete-config.md index d51e8fd..ecfcd3c 100644 --- a/docs/doc/gocd-cli_backup_delete-config.md +++ b/docs/doc/gocd-cli_backup_delete-config.md @@ -38,4 +38,4 @@ gocd-cli backup delete-config [flags] * [gocd-cli backup](gocd-cli_backup.md) - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_backup_get-config.md b/docs/doc/gocd-cli_backup_get-config.md index 00994de..6171ac6 100644 --- a/docs/doc/gocd-cli_backup_get-config.md +++ b/docs/doc/gocd-cli_backup_get-config.md @@ -38,4 +38,4 @@ gocd-cli backup get-config [flags] * [gocd-cli backup](gocd-cli_backup.md) - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_backup_schedule.md b/docs/doc/gocd-cli_backup_schedule.md index 54345ea..c42051d 100644 --- a/docs/doc/gocd-cli_backup_schedule.md +++ b/docs/doc/gocd-cli_backup_schedule.md @@ -38,4 +38,4 @@ gocd-cli backup schedule [flags] * [gocd-cli backup](gocd-cli_backup.md) - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_backup_stats.md b/docs/doc/gocd-cli_backup_stats.md index 3777e79..4f6c4f6 100644 --- a/docs/doc/gocd-cli_backup_stats.md +++ b/docs/doc/gocd-cli_backup_stats.md @@ -38,4 +38,4 @@ gocd-cli backup stats [flags] * [gocd-cli backup](gocd-cli_backup.md) - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_cluster-profile.md b/docs/doc/gocd-cli_cluster-profile.md index 16a0d45..37cb370 100644 --- a/docs/doc/gocd-cli_cluster-profile.md +++ b/docs/doc/gocd-cli_cluster-profile.md @@ -47,4 +47,4 @@ gocd-cli cluster-profile [flags] * [gocd-cli cluster-profile list](gocd-cli_cluster-profile_list.md) - Command to LIST all cluster profiles present in GoCD [https://api.gocd.org/current/#get-all-cluster-profiles] * [gocd-cli cluster-profile update](gocd-cli_cluster-profile_update.md) - Command to UPDATE a cluster profile with all specified configurations in GoCD [https://api.gocd.org/current/#update-a-cluster-profile] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_cluster-profile_create.md b/docs/doc/gocd-cli_cluster-profile_create.md index d69d9cc..49bec98 100644 --- a/docs/doc/gocd-cli_cluster-profile_create.md +++ b/docs/doc/gocd-cli_cluster-profile_create.md @@ -36,4 +36,4 @@ gocd-cli cluster-profile create [flags] * [gocd-cli cluster-profile](gocd-cli_cluster-profile.md) - Command to operate on cluster-profile present in GoCD [https://api.gocd.org/current/#cluster-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_cluster-profile_delete.md b/docs/doc/gocd-cli_cluster-profile_delete.md index a98f872..7d82d6c 100644 --- a/docs/doc/gocd-cli_cluster-profile_delete.md +++ b/docs/doc/gocd-cli_cluster-profile_delete.md @@ -36,4 +36,4 @@ gocd-cli cluster-profile delete [flags] * [gocd-cli cluster-profile](gocd-cli_cluster-profile.md) - Command to operate on cluster-profile present in GoCD [https://api.gocd.org/current/#cluster-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_cluster-profile_get-all.md b/docs/doc/gocd-cli_cluster-profile_get-all.md index 35309dd..cdd5198 100644 --- a/docs/doc/gocd-cli_cluster-profile_get-all.md +++ b/docs/doc/gocd-cli_cluster-profile_get-all.md @@ -36,4 +36,4 @@ gocd-cli cluster-profile get-all [flags] * [gocd-cli cluster-profile](gocd-cli_cluster-profile.md) - Command to operate on cluster-profile present in GoCD [https://api.gocd.org/current/#cluster-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_cluster-profile_get.md b/docs/doc/gocd-cli_cluster-profile_get.md index 1fd5886..d3fccad 100644 --- a/docs/doc/gocd-cli_cluster-profile_get.md +++ b/docs/doc/gocd-cli_cluster-profile_get.md @@ -36,4 +36,4 @@ gocd-cli cluster-profile get [flags] * [gocd-cli cluster-profile](gocd-cli_cluster-profile.md) - Command to operate on cluster-profile present in GoCD [https://api.gocd.org/current/#cluster-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_cluster-profile_list.md b/docs/doc/gocd-cli_cluster-profile_list.md index c215130..f4a4e6f 100644 --- a/docs/doc/gocd-cli_cluster-profile_list.md +++ b/docs/doc/gocd-cli_cluster-profile_list.md @@ -36,4 +36,4 @@ gocd-cli cluster-profile list [flags] * [gocd-cli cluster-profile](gocd-cli_cluster-profile.md) - Command to operate on cluster-profile present in GoCD [https://api.gocd.org/current/#cluster-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_cluster-profile_update.md b/docs/doc/gocd-cli_cluster-profile_update.md index 8bc2160..5d640f6 100644 --- a/docs/doc/gocd-cli_cluster-profile_update.md +++ b/docs/doc/gocd-cli_cluster-profile_update.md @@ -36,4 +36,4 @@ gocd-cli cluster-profile update [flags] * [gocd-cli cluster-profile](gocd-cli_cluster-profile.md) - Command to operate on cluster-profile present in GoCD [https://api.gocd.org/current/#cluster-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo.md b/docs/doc/gocd-cli_configrepo.md index 0df12a7..81d15e5 100644 --- a/docs/doc/gocd-cli_configrepo.md +++ b/docs/doc/gocd-cli_configrepo.md @@ -50,4 +50,4 @@ gocd-cli configrepo [flags] * [gocd-cli configrepo trigger-update](gocd-cli_configrepo_trigger-update.md) - Command to TRIGGER the update for config-repo to get latest revisions [https://api.gocd.org/current/#trigger-update-of-config-repository] * [gocd-cli configrepo update](gocd-cli_configrepo_update.md) - Command to UPDATE the config-repo present in GoCD [https://api.gocd.org/current/#update-config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_create.md b/docs/doc/gocd-cli_configrepo_create.md index 60b53bd..2a81ab4 100644 --- a/docs/doc/gocd-cli_configrepo_create.md +++ b/docs/doc/gocd-cli_configrepo_create.md @@ -36,4 +36,4 @@ gocd-cli configrepo create [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_delete.md b/docs/doc/gocd-cli_configrepo_delete.md index ecca0fa..9900dd3 100644 --- a/docs/doc/gocd-cli_configrepo_delete.md +++ b/docs/doc/gocd-cli_configrepo_delete.md @@ -36,4 +36,4 @@ gocd-cli configrepo delete [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_get-all.md b/docs/doc/gocd-cli_configrepo_get-all.md index a14c2dd..f2483ac 100644 --- a/docs/doc/gocd-cli_configrepo_get-all.md +++ b/docs/doc/gocd-cli_configrepo_get-all.md @@ -36,4 +36,4 @@ gocd-cli configrepo get-all [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_get.md b/docs/doc/gocd-cli_configrepo_get.md index ec20744..f9309aa 100644 --- a/docs/doc/gocd-cli_configrepo_get.md +++ b/docs/doc/gocd-cli_configrepo_get.md @@ -36,4 +36,4 @@ gocd-cli configrepo get [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_list.md b/docs/doc/gocd-cli_configrepo_list.md index 7054f30..cb9a4b3 100644 --- a/docs/doc/gocd-cli_configrepo_list.md +++ b/docs/doc/gocd-cli_configrepo_list.md @@ -36,4 +36,4 @@ gocd-cli configrepo list [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_preflight-check.md b/docs/doc/gocd-cli_configrepo_preflight-check.md index 8c5ceb2..f742acf 100644 --- a/docs/doc/gocd-cli_configrepo_preflight-check.md +++ b/docs/doc/gocd-cli_configrepo_preflight-check.md @@ -40,4 +40,4 @@ gocd-cli configrepo preflight-check [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_status.md b/docs/doc/gocd-cli_configrepo_status.md index 1d71f55..0375c43 100644 --- a/docs/doc/gocd-cli_configrepo_status.md +++ b/docs/doc/gocd-cli_configrepo_status.md @@ -36,4 +36,4 @@ gocd-cli configrepo status [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_trigger-update.md b/docs/doc/gocd-cli_configrepo_trigger-update.md index ad7f9b8..8b587da 100644 --- a/docs/doc/gocd-cli_configrepo_trigger-update.md +++ b/docs/doc/gocd-cli_configrepo_trigger-update.md @@ -36,4 +36,4 @@ gocd-cli configrepo trigger-update [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_configrepo_update.md b/docs/doc/gocd-cli_configrepo_update.md index 4f8262f..86b85f3 100644 --- a/docs/doc/gocd-cli_configrepo_update.md +++ b/docs/doc/gocd-cli_configrepo_update.md @@ -36,4 +36,4 @@ gocd-cli configrepo update [flags] * [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_elastic-agent-profile.md b/docs/doc/gocd-cli_elastic-agent-profile.md index 4cdcc30..ec5f40b 100644 --- a/docs/doc/gocd-cli_elastic-agent-profile.md +++ b/docs/doc/gocd-cli_elastic-agent-profile.md @@ -47,4 +47,4 @@ gocd-cli elastic-agent-profile [flags] * [gocd-cli elastic-agent-profile list](gocd-cli_elastic-agent-profile_list.md) - Command to LIST all elastic agent profiles present in GoCD [https://api.gocd.org/current/#get-all-elastic-agent-profiles] * [gocd-cli elastic-agent-profile update](gocd-cli_elastic-agent-profile_update.md) - Command to UPDATE a elastic agent profile with all specified configurations in GoCD [https://api.gocd.org/current/#update-an-elastic-agent-profile] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_elastic-agent-profile_create.md b/docs/doc/gocd-cli_elastic-agent-profile_create.md index f18368b..780ac2a 100644 --- a/docs/doc/gocd-cli_elastic-agent-profile_create.md +++ b/docs/doc/gocd-cli_elastic-agent-profile_create.md @@ -36,4 +36,4 @@ gocd-cli elastic-agent-profile create [flags] * [gocd-cli elastic-agent-profile](gocd-cli_elastic-agent-profile.md) - Command to operate on elastic-agent-profile in GoCD [https://api.gocd.org/current/#elastic-agent-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_elastic-agent-profile_delete.md b/docs/doc/gocd-cli_elastic-agent-profile_delete.md index 1669bf7..fd77285 100644 --- a/docs/doc/gocd-cli_elastic-agent-profile_delete.md +++ b/docs/doc/gocd-cli_elastic-agent-profile_delete.md @@ -36,4 +36,4 @@ gocd-cli elastic-agent-profile delete [flags] * [gocd-cli elastic-agent-profile](gocd-cli_elastic-agent-profile.md) - Command to operate on elastic-agent-profile in GoCD [https://api.gocd.org/current/#elastic-agent-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_elastic-agent-profile_get-all.md b/docs/doc/gocd-cli_elastic-agent-profile_get-all.md index 3340a16..c358755 100644 --- a/docs/doc/gocd-cli_elastic-agent-profile_get-all.md +++ b/docs/doc/gocd-cli_elastic-agent-profile_get-all.md @@ -36,4 +36,4 @@ gocd-cli elastic-agent-profile get-all [flags] * [gocd-cli elastic-agent-profile](gocd-cli_elastic-agent-profile.md) - Command to operate on elastic-agent-profile in GoCD [https://api.gocd.org/current/#elastic-agent-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_elastic-agent-profile_get.md b/docs/doc/gocd-cli_elastic-agent-profile_get.md index 797755a..a42bd3f 100644 --- a/docs/doc/gocd-cli_elastic-agent-profile_get.md +++ b/docs/doc/gocd-cli_elastic-agent-profile_get.md @@ -36,4 +36,4 @@ gocd-cli elastic-agent-profile get [flags] * [gocd-cli elastic-agent-profile](gocd-cli_elastic-agent-profile.md) - Command to operate on elastic-agent-profile in GoCD [https://api.gocd.org/current/#elastic-agent-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_elastic-agent-profile_list.md b/docs/doc/gocd-cli_elastic-agent-profile_list.md index d455031..e4fa691 100644 --- a/docs/doc/gocd-cli_elastic-agent-profile_list.md +++ b/docs/doc/gocd-cli_elastic-agent-profile_list.md @@ -36,4 +36,4 @@ gocd-cli elastic-agent-profile list [flags] * [gocd-cli elastic-agent-profile](gocd-cli_elastic-agent-profile.md) - Command to operate on elastic-agent-profile in GoCD [https://api.gocd.org/current/#elastic-agent-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_elastic-agent-profile_update.md b/docs/doc/gocd-cli_elastic-agent-profile_update.md index 1504e49..f65a929 100644 --- a/docs/doc/gocd-cli_elastic-agent-profile_update.md +++ b/docs/doc/gocd-cli_elastic-agent-profile_update.md @@ -36,4 +36,4 @@ gocd-cli elastic-agent-profile update [flags] * [gocd-cli elastic-agent-profile](gocd-cli_elastic-agent-profile.md) - Command to operate on elastic-agent-profile in GoCD [https://api.gocd.org/current/#elastic-agent-profiles] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_encryption.md b/docs/doc/gocd-cli_encryption.md index 3e5845e..146ccc5 100644 --- a/docs/doc/gocd-cli_encryption.md +++ b/docs/doc/gocd-cli_encryption.md @@ -44,4 +44,4 @@ gocd-cli encryption [flags] * [gocd-cli encryption decrypt](gocd-cli_encryption_decrypt.md) - Command to decrypt encrypted value [https://github.com/nikhilsbhat/gocd-sdk-go/blob/master/encryption.go#L49] * [gocd-cli encryption encrypt](gocd-cli_encryption_encrypt.md) - Command to encrypt plain text value [https://api.gocd.org/current/#encryption] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_encryption_decrypt.md b/docs/doc/gocd-cli_encryption_decrypt.md index ef74596..6ea99c4 100644 --- a/docs/doc/gocd-cli_encryption_decrypt.md +++ b/docs/doc/gocd-cli_encryption_decrypt.md @@ -37,4 +37,4 @@ gocd-cli encryption decrypt [flags] * [gocd-cli encryption](gocd-cli_encryption.md) - Command to encrypt/decrypt plain text value [https://api.gocd.org/current/#encryption] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_encryption_encrypt.md b/docs/doc/gocd-cli_encryption_encrypt.md index f16cc92..17883ce 100644 --- a/docs/doc/gocd-cli_encryption_encrypt.md +++ b/docs/doc/gocd-cli_encryption_encrypt.md @@ -37,4 +37,4 @@ gocd-cli encryption encrypt [flags] * [gocd-cli encryption](gocd-cli_encryption.md) - Command to encrypt/decrypt plain text value [https://api.gocd.org/current/#encryption] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment.md b/docs/doc/gocd-cli_environment.md index 18b58b6..b5496fb 100644 --- a/docs/doc/gocd-cli_environment.md +++ b/docs/doc/gocd-cli_environment.md @@ -48,4 +48,4 @@ gocd-cli environment [flags] * [gocd-cli environment patch](gocd-cli_environment_patch.md) - Command to PATCH the environment with the latest specified configuration [https://api.gocd.org/current/#patch-an-environment] * [gocd-cli environment update](gocd-cli_environment_update.md) - Command to UPDATE the environment with the latest specified configuration [https://api.gocd.org/current/#update-an-environment] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment_create.md b/docs/doc/gocd-cli_environment_create.md index 1636052..edd1c91 100644 --- a/docs/doc/gocd-cli_environment_create.md +++ b/docs/doc/gocd-cli_environment_create.md @@ -36,4 +36,4 @@ gocd-cli environment create [flags] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment_delete.md b/docs/doc/gocd-cli_environment_delete.md index 1ee291a..b2998c3 100644 --- a/docs/doc/gocd-cli_environment_delete.md +++ b/docs/doc/gocd-cli_environment_delete.md @@ -36,4 +36,4 @@ gocd-cli environment delete [flags] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment_get-all.md b/docs/doc/gocd-cli_environment_get-all.md index 025a0e6..2ae985f 100644 --- a/docs/doc/gocd-cli_environment_get-all.md +++ b/docs/doc/gocd-cli_environment_get-all.md @@ -36,4 +36,4 @@ gocd-cli environment get-all [flags] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment_get.md b/docs/doc/gocd-cli_environment_get.md index 426d115..b5341b4 100644 --- a/docs/doc/gocd-cli_environment_get.md +++ b/docs/doc/gocd-cli_environment_get.md @@ -36,4 +36,4 @@ gocd-cli environment get [flags] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment_list.md b/docs/doc/gocd-cli_environment_list.md index 088df48..5cf6ec8 100644 --- a/docs/doc/gocd-cli_environment_list.md +++ b/docs/doc/gocd-cli_environment_list.md @@ -36,4 +36,4 @@ gocd-cli environment list [flags] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment_patch.md b/docs/doc/gocd-cli_environment_patch.md index 4d140a2..1d1d0b6 100644 --- a/docs/doc/gocd-cli_environment_patch.md +++ b/docs/doc/gocd-cli_environment_patch.md @@ -36,4 +36,4 @@ gocd-cli environment patch [flags] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_environment_update.md b/docs/doc/gocd-cli_environment_update.md index dfeac44..bcb4f87 100644 --- a/docs/doc/gocd-cli_environment_update.md +++ b/docs/doc/gocd-cli_environment_update.md @@ -36,4 +36,4 @@ gocd-cli environment update [flags] * [gocd-cli environment](gocd-cli_environment.md) - Command to operate on environments present in GoCD [https://api.gocd.org/current/#environment-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_job.md b/docs/doc/gocd-cli_job.md new file mode 100644 index 0000000..77d0277 --- /dev/null +++ b/docs/doc/gocd-cli_job.md @@ -0,0 +1,46 @@ +## gocd-cli job + +Command to operate on jobs present in GoCD + +### Synopsis + +Command leverages GoCD job apis' +[https://api.gocd.org/current/#scheduled-jobs] to +GET/SCHEDULE jobs of specific pipelines present GoCD + +``` +gocd-cli job [flags] +``` + +### Options + +``` + -h, --help help for job +``` + +### Options inherited from parent commands + +``` + -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) + --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one + --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. + --json enable this to Render output in JSON format + -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") + --no-color enable this to Render output in YAML format + -p, --password string password to authenticate with GoCD server + -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath + more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries + --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) + --server-url string GoCD server URL base path (default "http://localhost:8153/go") + --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) + --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) + -u, --username string username to authenticate with GoCD server + --yaml enable this to Render output in YAML format +``` + +### SEE ALSO + +* [gocd-cli](gocd-cli.md) - Command line interface for GoCD +* [gocd-cli job scheduled](gocd-cli_job_scheduled.md) - Command to GET a list of scheduled jobs in GoCD [https://api.gocd.org/current/#scheduled-jobs] + +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_job_scheduled.md b/docs/doc/gocd-cli_job_scheduled.md new file mode 100644 index 0000000..236b9b5 --- /dev/null +++ b/docs/doc/gocd-cli_job_scheduled.md @@ -0,0 +1,53 @@ +## gocd-cli job scheduled + +Command to GET a list of scheduled jobs in GoCD [https://api.gocd.org/current/#scheduled-jobs] + +``` +gocd-cli job scheduled [flags] +``` + +### Examples + +``` +gocd-cli job scheduled" +``` + +### Options + +``` + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -h, --help help for scheduled + -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 + --un-pause disable to pause a pipeline +``` + +### Options inherited from parent commands + +``` + -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) + --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one + --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. + --json enable this to Render output in JSON format + -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") + --no-color enable this to Render output in YAML format + -p, --password string password to authenticate with GoCD server + -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath + more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries + --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) + --server-url string GoCD server URL base path (default "http://localhost:8153/go") + --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) + --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) + -u, --username string username to authenticate with GoCD server + --yaml enable this to Render output in YAML format +``` + +### SEE ALSO + +* [gocd-cli job](gocd-cli_job.md) - Command to operate on jobs present in GoCD + +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_maintenance.md b/docs/doc/gocd-cli_maintenance.md index da20182..93fa7f2 100644 --- a/docs/doc/gocd-cli_maintenance.md +++ b/docs/doc/gocd-cli_maintenance.md @@ -46,4 +46,4 @@ gocd-cli maintenance [flags] [https://api.gocd.org/current/#enable-maintenance-mode,https://api.gocd.org/current/#disable-maintenance-mode] * [gocd-cli maintenance get](gocd-cli_maintenance_get.md) - Command to GET a maintenance mode information from GoCD [https://api.gocd.org/current/#get-maintenance-mode-info] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_maintenance_action.md b/docs/doc/gocd-cli_maintenance_action.md index 3c819b3..820c2dd 100644 --- a/docs/doc/gocd-cli_maintenance_action.md +++ b/docs/doc/gocd-cli_maintenance_action.md @@ -45,4 +45,4 @@ gocd-cli maintenance --enable/--disable * [gocd-cli maintenance](gocd-cli_maintenance.md) - Command to operate on maintenance modes in GoCD [https://api.gocd.org/current/#maintenance-mode] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_maintenance_get.md b/docs/doc/gocd-cli_maintenance_get.md index 71d4db5..d43d644 100644 --- a/docs/doc/gocd-cli_maintenance_get.md +++ b/docs/doc/gocd-cli_maintenance_get.md @@ -44,4 +44,4 @@ gocd-cli maintenance get * [gocd-cli maintenance](gocd-cli_maintenance.md) - Command to operate on maintenance modes in GoCD [https://api.gocd.org/current/#maintenance-mode] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline-group.md b/docs/doc/gocd-cli_pipeline-group.md index c27f43d..12f395e 100644 --- a/docs/doc/gocd-cli_pipeline-group.md +++ b/docs/doc/gocd-cli_pipeline-group.md @@ -47,4 +47,4 @@ gocd-cli pipeline-group [flags] * [gocd-cli pipeline-group list](gocd-cli_pipeline-group_list.md) - Command to LIST all the pipeline group present in GoCD [https://api.gocd.org/current/#get-all-pipeline-groups] * [gocd-cli pipeline-group update](gocd-cli_pipeline-group_update.md) - Command to UPDATE the pipeline group with the latest specified configuration [https://api.gocd.org/current/#update-a-pipeline-group] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline-group_create.md b/docs/doc/gocd-cli_pipeline-group_create.md index f6a0aa3..408c219 100644 --- a/docs/doc/gocd-cli_pipeline-group_create.md +++ b/docs/doc/gocd-cli_pipeline-group_create.md @@ -43,4 +43,4 @@ gocd-cli pipeline-group create movies --from-file pipeline-group-movies.yaml --l * [gocd-cli pipeline-group](gocd-cli_pipeline-group.md) - Command to operate on pipeline groups present in GoCD [https://api.gocd.org/current/#pipeline-group-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline-group_delete.md b/docs/doc/gocd-cli_pipeline-group_delete.md index ef54c86..4a469a3 100644 --- a/docs/doc/gocd-cli_pipeline-group_delete.md +++ b/docs/doc/gocd-cli_pipeline-group_delete.md @@ -42,4 +42,4 @@ gocd-cli pipeline-group delete movies * [gocd-cli pipeline-group](gocd-cli_pipeline-group.md) - Command to operate on pipeline groups present in GoCD [https://api.gocd.org/current/#pipeline-group-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline-group_get-all.md b/docs/doc/gocd-cli_pipeline-group_get-all.md index 2de89b5..89f7eb9 100644 --- a/docs/doc/gocd-cli_pipeline-group_get-all.md +++ b/docs/doc/gocd-cli_pipeline-group_get-all.md @@ -43,4 +43,4 @@ gocd-cli pipeline-group get-all --query "[*] | name eq sample-group" * [gocd-cli pipeline-group](gocd-cli_pipeline-group.md) - Command to operate on pipeline groups present in GoCD [https://api.gocd.org/current/#pipeline-group-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline-group_get.md b/docs/doc/gocd-cli_pipeline-group_get.md index df696c2..29dd722 100644 --- a/docs/doc/gocd-cli_pipeline-group_get.md +++ b/docs/doc/gocd-cli_pipeline-group_get.md @@ -43,4 +43,4 @@ gocd-cli pipeline-group get movies --query "pipelines.[*] | name" --yaml * [gocd-cli pipeline-group](gocd-cli_pipeline-group.md) - Command to operate on pipeline groups present in GoCD [https://api.gocd.org/current/#pipeline-group-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline-group_list.md b/docs/doc/gocd-cli_pipeline-group_list.md index e0f5871..accc0c4 100644 --- a/docs/doc/gocd-cli_pipeline-group_list.md +++ b/docs/doc/gocd-cli_pipeline-group_list.md @@ -42,4 +42,4 @@ gocd-cli pipeline-group list * [gocd-cli pipeline-group](gocd-cli_pipeline-group.md) - Command to operate on pipeline groups present in GoCD [https://api.gocd.org/current/#pipeline-group-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline-group_update.md b/docs/doc/gocd-cli_pipeline-group_update.md index dfee37c..5e02c59 100644 --- a/docs/doc/gocd-cli_pipeline-group_update.md +++ b/docs/doc/gocd-cli_pipeline-group_update.md @@ -43,4 +43,4 @@ gocd-cli pipeline-group update movies --from-file pipeline-group-movies.yaml --l * [gocd-cli pipeline-group](gocd-cli_pipeline-group.md) - Command to operate on pipeline groups present in GoCD [https://api.gocd.org/current/#pipeline-group-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline.md b/docs/doc/gocd-cli_pipeline.md index 4447bd9..0016d30 100644 --- a/docs/doc/gocd-cli_pipeline.md +++ b/docs/doc/gocd-cli_pipeline.md @@ -1,10 +1,10 @@ ## gocd-cli pipeline -Command to operate on pipelines present in GoCD +Command to operate on pipelines present in GoCD ### Synopsis -Command leverages GoCD pipeline group config apis' +Command leverages GoCD pipeline apis' [https://api.gocd.org/current/#pipeline-instances, https://api.gocd.org/current/#pipeline-config, https://api.gocd.org/current/#pipelines] to GET/PAUSE/UNPAUSE/UNLOCK/SCHEDULE and comment on a GoCD pipeline @@ -15,12 +15,7 @@ gocd-cli pipeline [flags] ### Options ``` - -h, --help help for pipeline - -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 - --un-pause disable to pause a pipeline + -h, --help help for pipeline ``` ### Options inherited from parent commands @@ -49,10 +44,15 @@ gocd-cli pipeline [flags] * [gocd-cli pipeline action](gocd-cli_pipeline_action.md) - Command to PAUSE/UNPAUSE a specific pipeline present in GoCD, [https://api.gocd.org/current/#pause-a-pipeline,https://api.gocd.org/current/#unpause-a-pipeline] * [gocd-cli pipeline comment](gocd-cli_pipeline_comment.md) - Command to COMMENT on a specific pipeline instance present in GoCD [https://api.gocd.org/current/#comment-on-pipeline-instance] +* [gocd-cli pipeline create](gocd-cli_pipeline_create.md) - Command to CREATE the pipeline with all specified configuration [https://api.gocd.org/current/#create-a-pipeline] +* [gocd-cli pipeline delete](gocd-cli_pipeline_delete.md) - Command to DELETE the specified pipeline from GoCD [https://api.gocd.org/current/#delete-a-pipeline] +* [gocd-cli pipeline get](gocd-cli_pipeline_get.md) - Command to GET pipeline config of a specified pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-config * [gocd-cli pipeline get-all](gocd-cli_pipeline_get-all.md) - Command to GET all pipelines present in GoCD [https://api.gocd.org/current/#get-feed-of-all-stages-in-a-pipeline] * [gocd-cli pipeline instance](gocd-cli_pipeline_instance.md) - Command to GET instance of a specific pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-instance] * [gocd-cli pipeline list](gocd-cli_pipeline_list.md) - Command to LIST all the pipelines present in GoCD [https://api.gocd.org/current/#get-feed-of-all-stages-in-a-pipeline] * [gocd-cli pipeline schedule](gocd-cli_pipeline_schedule.md) - Command to SCHEDULE a specific pipeline present in GoCD [https://api.gocd.org/current/#scheduling-pipelines] * [gocd-cli pipeline status](gocd-cli_pipeline_status.md) - Command to GET status of a specific pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-status] +* [gocd-cli pipeline template](gocd-cli_pipeline_template.md) - Command to EXTRACT template from specific pipeline instance present in GoCD [https://api.gocd.org/current/#extract-template-from-pipeline] +* [gocd-cli pipeline update](gocd-cli_pipeline_update.md) - Command to UPDATE the pipeline config with the latest specified configuration [https://api.gocd.org/current/#edit-pipeline-config] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_action.md b/docs/doc/gocd-cli_pipeline_action.md index ffe4e79..c8bc3a6 100644 --- a/docs/doc/gocd-cli_pipeline_action.md +++ b/docs/doc/gocd-cli_pipeline_action.md @@ -16,7 +16,15 @@ gocd-cli pipeline action sample-pipeline --pause/--un-pause ### Options ``` - -h, --help help for action + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -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 + --un-pause disable to pause a pipeline ``` ### Options inherited from parent commands @@ -25,27 +33,22 @@ gocd-cli pipeline action sample-pipeline --pause/--un-pause -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. - -i, --instance int instance number of a pipeline --json enable this to Render output in JSON format -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") - -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 --no-color enable this to Render output in YAML format -p, --password string password to authenticate with GoCD server - --pause enable to pause a pipeline -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) --server-url string GoCD server URL base path (default "http://localhost:8153/go") --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) - --un-pause disable to pause a pipeline -u, --username string username to authenticate with GoCD server --yaml enable this to Render output in YAML format ``` ### SEE ALSO -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_comment.md b/docs/doc/gocd-cli_pipeline_comment.md index cf24112..40e0e83 100644 --- a/docs/doc/gocd-cli_pipeline_comment.md +++ b/docs/doc/gocd-cli_pipeline_comment.md @@ -15,7 +15,15 @@ gocd-cli pipeline comment --message "message to be commented" ### Options ``` - -h, --help help for comment + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -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 + --un-pause disable to pause a pipeline ``` ### Options inherited from parent commands @@ -24,27 +32,22 @@ gocd-cli pipeline comment --message "message to be commented" -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. - -i, --instance int instance number of a pipeline --json enable this to Render output in JSON format -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") - -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 --no-color enable this to Render output in YAML format -p, --password string password to authenticate with GoCD server - --pause enable to pause a pipeline -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) --server-url string GoCD server URL base path (default "http://localhost:8153/go") --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) - --un-pause disable to pause a pipeline -u, --username string username to authenticate with GoCD server --yaml enable this to Render output in YAML format ``` ### SEE ALSO -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_create.md b/docs/doc/gocd-cli_pipeline_create.md new file mode 100644 index 0000000..e68df03 --- /dev/null +++ b/docs/doc/gocd-cli_pipeline_create.md @@ -0,0 +1,54 @@ +## gocd-cli pipeline create + +Command to CREATE the pipeline with all specified configuration [https://api.gocd.org/current/#create-a-pipeline] + +``` +gocd-cli pipeline create [flags] +``` + +### Examples + +``` +gocd-cli pipeline create sample-pipeline --from-file sample-pipeline.yaml --log-level debug +// the inputs can be passed either from file using '--from-file' flag or entire content as argument to command +``` + +### Options + +``` + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -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 + --un-pause disable to pause a pipeline +``` + +### Options inherited from parent commands + +``` + -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) + --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one + --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. + --json enable this to Render output in JSON format + -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") + --no-color enable this to Render output in YAML format + -p, --password string password to authenticate with GoCD server + -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath + more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries + --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) + --server-url string GoCD server URL base path (default "http://localhost:8153/go") + --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) + --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) + -u, --username string username to authenticate with GoCD server + --yaml enable this to Render output in YAML format +``` + +### SEE ALSO + +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD + +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_delete.md b/docs/doc/gocd-cli_pipeline_delete.md new file mode 100644 index 0000000..51d14f3 --- /dev/null +++ b/docs/doc/gocd-cli_pipeline_delete.md @@ -0,0 +1,45 @@ +## gocd-cli pipeline delete + +Command to DELETE the specified pipeline from GoCD [https://api.gocd.org/current/#delete-a-pipeline] + +``` +gocd-cli pipeline delete [flags] +``` + +### Examples + +``` +gocd-cli pipeline delete movies +``` + +### Options + +``` + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) + --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one + --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. + --json enable this to Render output in JSON format + -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") + --no-color enable this to Render output in YAML format + -p, --password string password to authenticate with GoCD server + -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath + more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries + --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) + --server-url string GoCD server URL base path (default "http://localhost:8153/go") + --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) + --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) + -u, --username string username to authenticate with GoCD server + --yaml enable this to Render output in YAML format +``` + +### SEE ALSO + +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD + +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_get-all.md b/docs/doc/gocd-cli_pipeline_get-all.md index 85d55fe..3f4ff41 100644 --- a/docs/doc/gocd-cli_pipeline_get-all.md +++ b/docs/doc/gocd-cli_pipeline_get-all.md @@ -24,27 +24,22 @@ gocd-cli pipeline get-all --query "[*] | name eq sample-group" -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. - -i, --instance int instance number of a pipeline --json enable this to Render output in JSON format -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") - -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 --no-color enable this to Render output in YAML format -p, --password string password to authenticate with GoCD server - --pause enable to pause a pipeline -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) --server-url string GoCD server URL base path (default "http://localhost:8153/go") --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) - --un-pause disable to pause a pipeline -u, --username string username to authenticate with GoCD server --yaml enable this to Render output in YAML format ``` ### SEE ALSO -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_get.md b/docs/doc/gocd-cli_pipeline_get.md new file mode 100644 index 0000000..9380b07 --- /dev/null +++ b/docs/doc/gocd-cli_pipeline_get.md @@ -0,0 +1,45 @@ +## gocd-cli pipeline get + +Command to GET pipeline config of a specified pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-config + +``` +gocd-cli pipeline get [flags] +``` + +### Examples + +``` +gocd-cli pipeline get sample-pipeline --query "[*] | name eq sample-group" +``` + +### Options + +``` + -h, --help help for get +``` + +### Options inherited from parent commands + +``` + -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) + --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one + --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. + --json enable this to Render output in JSON format + -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") + --no-color enable this to Render output in YAML format + -p, --password string password to authenticate with GoCD server + -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath + more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries + --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) + --server-url string GoCD server URL base path (default "http://localhost:8153/go") + --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) + --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) + -u, --username string username to authenticate with GoCD server + --yaml enable this to Render output in YAML format +``` + +### SEE ALSO + +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD + +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_instance.md b/docs/doc/gocd-cli_pipeline_instance.md index 8dc8d5a..83276eb 100644 --- a/docs/doc/gocd-cli_pipeline_instance.md +++ b/docs/doc/gocd-cli_pipeline_instance.md @@ -15,7 +15,15 @@ gocd-cli pipeline instance sample-pipeline --instance 10 ### Options ``` - -h, --help help for instance + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -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 + --un-pause disable to pause a pipeline ``` ### Options inherited from parent commands @@ -24,27 +32,22 @@ gocd-cli pipeline instance sample-pipeline --instance 10 -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. - -i, --instance int instance number of a pipeline --json enable this to Render output in JSON format -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") - -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 --no-color enable this to Render output in YAML format -p, --password string password to authenticate with GoCD server - --pause enable to pause a pipeline -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) --server-url string GoCD server URL base path (default "http://localhost:8153/go") --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) - --un-pause disable to pause a pipeline -u, --username string username to authenticate with GoCD server --yaml enable this to Render output in YAML format ``` ### SEE ALSO -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_list.md b/docs/doc/gocd-cli_pipeline_list.md index 23745fe..8e5c009 100644 --- a/docs/doc/gocd-cli_pipeline_list.md +++ b/docs/doc/gocd-cli_pipeline_list.md @@ -24,27 +24,22 @@ gocd-cli pipeline list -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. - -i, --instance int instance number of a pipeline --json enable this to Render output in JSON format -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") - -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 --no-color enable this to Render output in YAML format -p, --password string password to authenticate with GoCD server - --pause enable to pause a pipeline -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) --server-url string GoCD server URL base path (default "http://localhost:8153/go") --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) - --un-pause disable to pause a pipeline -u, --username string username to authenticate with GoCD server --yaml enable this to Render output in YAML format ``` ### SEE ALSO -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_schedule.md b/docs/doc/gocd-cli_pipeline_schedule.md index bf525aa..93db93f 100644 --- a/docs/doc/gocd-cli_pipeline_schedule.md +++ b/docs/doc/gocd-cli_pipeline_schedule.md @@ -15,7 +15,15 @@ gocd-cli pipeline schedule --name sample --from-file schedule-config.yaml ### Options ``` - -h, --help help for schedule + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -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 + --un-pause disable to pause a pipeline ``` ### Options inherited from parent commands @@ -24,27 +32,22 @@ gocd-cli pipeline schedule --name sample --from-file schedule-config.yaml -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. - -i, --instance int instance number of a pipeline --json enable this to Render output in JSON format -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") - -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 --no-color enable this to Render output in YAML format -p, --password string password to authenticate with GoCD server - --pause enable to pause a pipeline -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) --server-url string GoCD server URL base path (default "http://localhost:8153/go") --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) - --un-pause disable to pause a pipeline -u, --username string username to authenticate with GoCD server --yaml enable this to Render output in YAML format ``` ### SEE ALSO -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_status.md b/docs/doc/gocd-cli_pipeline_status.md index d0a0137..bd9021c 100644 --- a/docs/doc/gocd-cli_pipeline_status.md +++ b/docs/doc/gocd-cli_pipeline_status.md @@ -24,27 +24,22 @@ gocd-cli pipeline status sample-pipeline -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. - -i, --instance int instance number of a pipeline --json enable this to Render output in JSON format -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") - -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 --no-color enable this to Render output in YAML format -p, --password string password to authenticate with GoCD server - --pause enable to pause a pipeline -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) --server-url string GoCD server URL base path (default "http://localhost:8153/go") --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) - --un-pause disable to pause a pipeline -u, --username string username to authenticate with GoCD server --yaml enable this to Render output in YAML format ``` ### SEE ALSO -* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_template.md b/docs/doc/gocd-cli_pipeline_template.md new file mode 100644 index 0000000..6523b75 --- /dev/null +++ b/docs/doc/gocd-cli_pipeline_template.md @@ -0,0 +1,53 @@ +## gocd-cli pipeline template + +Command to EXTRACT template from specific pipeline instance present in GoCD [https://api.gocd.org/current/#extract-template-from-pipeline] + +``` +gocd-cli pipeline template [flags] +``` + +### Examples + +``` +gocd-cli pipeline template --name sample-pipeline --template-name sample-template +``` + +### Options + +``` + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -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 + --un-pause disable to pause a pipeline +``` + +### Options inherited from parent commands + +``` + -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) + --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one + --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. + --json enable this to Render output in JSON format + -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") + --no-color enable this to Render output in YAML format + -p, --password string password to authenticate with GoCD server + -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath + more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries + --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) + --server-url string GoCD server URL base path (default "http://localhost:8153/go") + --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) + --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) + -u, --username string username to authenticate with GoCD server + --yaml enable this to Render output in YAML format +``` + +### SEE ALSO + +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD + +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_pipeline_update.md b/docs/doc/gocd-cli_pipeline_update.md new file mode 100644 index 0000000..919d733 --- /dev/null +++ b/docs/doc/gocd-cli_pipeline_update.md @@ -0,0 +1,54 @@ +## gocd-cli pipeline update + +Command to UPDATE the pipeline config with the latest specified configuration [https://api.gocd.org/current/#edit-pipeline-config] + +``` +gocd-cli pipeline update [flags] +``` + +### Examples + +``` +gocd-cli pipeline update sample-movies --from-file sample-movies.yaml --log-level debug +// the inputs can be passed either from file using '--from-file' flag or entire content as argument to command +``` + +### Options + +``` + --etag string etag used to identify the pipeline config. If you don't have one get it by using pipeline get command + -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 + --un-pause disable to pause a pipeline +``` + +### Options inherited from parent commands + +``` + -t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) + --ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one + --from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. + --json enable this to Render output in JSON format + -l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") + --no-color enable this to Render output in YAML format + -p, --password string password to authenticate with GoCD server + -q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath + more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries + --save-config enable this to locally save auth configs used to connect GoCD server (path: $HOME/.gocd/auth_config.yaml) + --server-url string GoCD server URL base path (default "http://localhost:8153/go") + --skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) + --to-file string file to which the output needs to be written to (this works only if --yaml or --json is enabled) + -u, --username string username to authenticate with GoCD server + --yaml enable this to Render output in YAML format +``` + +### SEE ALSO + +* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD + +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_plugin.md b/docs/doc/gocd-cli_plugin.md index 9f65f6e..6f869cf 100644 --- a/docs/doc/gocd-cli_plugin.md +++ b/docs/doc/gocd-cli_plugin.md @@ -47,4 +47,4 @@ gocd-cli plugin [flags] * [gocd-cli plugin list](gocd-cli_plugin_list.md) - Command to LIST all plugins present in GoCD * [gocd-cli plugin update-settings](gocd-cli_plugin_update-settings.md) - Command to UPDATE settings of a specified plugin present in GoCD [https://api.gocd.org/current/#update-plugin-settings] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_plugin_create-settings.md b/docs/doc/gocd-cli_plugin_create-settings.md index 7c82130..564e819 100644 --- a/docs/doc/gocd-cli_plugin_create-settings.md +++ b/docs/doc/gocd-cli_plugin_create-settings.md @@ -36,4 +36,4 @@ gocd-cli plugin create-settings [flags] * [gocd-cli plugin](gocd-cli_plugin.md) - Command to operate on plugins present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_plugin_get-info-all.md b/docs/doc/gocd-cli_plugin_get-info-all.md index 8bbf608..97d07a8 100644 --- a/docs/doc/gocd-cli_plugin_get-info-all.md +++ b/docs/doc/gocd-cli_plugin_get-info-all.md @@ -36,4 +36,4 @@ gocd-cli plugin get-info-all [flags] * [gocd-cli plugin](gocd-cli_plugin.md) - Command to operate on plugins present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_plugin_get-info.md b/docs/doc/gocd-cli_plugin_get-info.md index 90ad8a4..374d1ea 100644 --- a/docs/doc/gocd-cli_plugin_get-info.md +++ b/docs/doc/gocd-cli_plugin_get-info.md @@ -36,4 +36,4 @@ gocd-cli plugin get-info [flags] * [gocd-cli plugin](gocd-cli_plugin.md) - Command to operate on plugins present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_plugin_get-settings.md b/docs/doc/gocd-cli_plugin_get-settings.md index 9084397..90e371b 100644 --- a/docs/doc/gocd-cli_plugin_get-settings.md +++ b/docs/doc/gocd-cli_plugin_get-settings.md @@ -36,4 +36,4 @@ gocd-cli plugin get-settings [flags] * [gocd-cli plugin](gocd-cli_plugin.md) - Command to operate on plugins present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_plugin_list.md b/docs/doc/gocd-cli_plugin_list.md index ef87c54..fce3c19 100644 --- a/docs/doc/gocd-cli_plugin_list.md +++ b/docs/doc/gocd-cli_plugin_list.md @@ -36,4 +36,4 @@ gocd-cli plugin list [flags] * [gocd-cli plugin](gocd-cli_plugin.md) - Command to operate on plugins present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_plugin_update-settings.md b/docs/doc/gocd-cli_plugin_update-settings.md index f2f2767..472b7cb 100644 --- a/docs/doc/gocd-cli_plugin_update-settings.md +++ b/docs/doc/gocd-cli_plugin_update-settings.md @@ -36,4 +36,4 @@ gocd-cli plugin update-settings [flags] * [gocd-cli plugin](gocd-cli_plugin.md) - Command to operate on plugins present in GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_server.md b/docs/doc/gocd-cli_server.md index 13b7147..ae463f4 100644 --- a/docs/doc/gocd-cli_server.md +++ b/docs/doc/gocd-cli_server.md @@ -43,4 +43,4 @@ gocd-cli server [flags] * [gocd-cli server health](gocd-cli_server_health.md) - Command to monitor if the GoCD server is up and running [https://api.gocd.org/current/#check-server-health] * [gocd-cli server health-messages](gocd-cli_server_health-messages.md) - Command to see any errors and warnings generated by the GoCD server as part of its normal routine [https://api.gocd.org/current/#get-server-health-messages] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_server_health-messages.md b/docs/doc/gocd-cli_server_health-messages.md index 97cfd95..12db176 100644 --- a/docs/doc/gocd-cli_server_health-messages.md +++ b/docs/doc/gocd-cli_server_health-messages.md @@ -36,4 +36,4 @@ gocd-cli server health-messages [flags] * [gocd-cli server](gocd-cli_server.md) - Command to operate on GoCD server health status -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_server_health.md b/docs/doc/gocd-cli_server_health.md index 621c0d1..a630fd2 100644 --- a/docs/doc/gocd-cli_server_health.md +++ b/docs/doc/gocd-cli_server_health.md @@ -36,4 +36,4 @@ gocd-cli server health [flags] * [gocd-cli server](gocd-cli_server.md) - Command to operate on GoCD server health status -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_user.md b/docs/doc/gocd-cli_user.md index b570b9f..de0089b 100644 --- a/docs/doc/gocd-cli_user.md +++ b/docs/doc/gocd-cli_user.md @@ -47,4 +47,4 @@ gocd-cli user [flags] * [gocd-cli user get-all](gocd-cli_user_get-all.md) - Command to GET all users present in GoCD [https://api.gocd.org/current/#get-all-users] * [gocd-cli user update](gocd-cli_user_update.md) - Command to UPDATE user present in GoCD [https://api.gocd.org/current/#update-a-user] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_user_create.md b/docs/doc/gocd-cli_user_create.md index 3621b6c..2ff47f0 100644 --- a/docs/doc/gocd-cli_user_create.md +++ b/docs/doc/gocd-cli_user_create.md @@ -36,4 +36,4 @@ gocd-cli user create [flags] * [gocd-cli user](gocd-cli_user.md) - Command to operate on users in GoCD [https://api.gocd.org/current/#users] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_user_delete-bulk.md b/docs/doc/gocd-cli_user_delete-bulk.md index b1a1a48..1bdfbe6 100644 --- a/docs/doc/gocd-cli_user_delete-bulk.md +++ b/docs/doc/gocd-cli_user_delete-bulk.md @@ -36,4 +36,4 @@ gocd-cli user delete-bulk [flags] * [gocd-cli user](gocd-cli_user.md) - Command to operate on users in GoCD [https://api.gocd.org/current/#users] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_user_delete.md b/docs/doc/gocd-cli_user_delete.md index b634090..d051c26 100644 --- a/docs/doc/gocd-cli_user_delete.md +++ b/docs/doc/gocd-cli_user_delete.md @@ -36,4 +36,4 @@ gocd-cli user delete [flags] * [gocd-cli user](gocd-cli_user.md) - Command to operate on users in GoCD [https://api.gocd.org/current/#users] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_user_get-all.md b/docs/doc/gocd-cli_user_get-all.md index 9becbf5..8cfec04 100644 --- a/docs/doc/gocd-cli_user_get-all.md +++ b/docs/doc/gocd-cli_user_get-all.md @@ -36,4 +36,4 @@ gocd-cli user get-all [flags] * [gocd-cli user](gocd-cli_user.md) - Command to operate on users in GoCD [https://api.gocd.org/current/#users] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_user_get.md b/docs/doc/gocd-cli_user_get.md index 320764e..66cb039 100644 --- a/docs/doc/gocd-cli_user_get.md +++ b/docs/doc/gocd-cli_user_get.md @@ -36,4 +36,4 @@ gocd-cli user get [flags] * [gocd-cli user](gocd-cli_user.md) - Command to operate on users in GoCD [https://api.gocd.org/current/#users] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_user_update.md b/docs/doc/gocd-cli_user_update.md index 9f81bbf..bd39dbd 100644 --- a/docs/doc/gocd-cli_user_update.md +++ b/docs/doc/gocd-cli_user_update.md @@ -36,4 +36,4 @@ gocd-cli user update [flags] * [gocd-cli user](gocd-cli_user.md) - Command to operate on users in GoCD [https://api.gocd.org/current/#users] -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/docs/doc/gocd-cli_version.md b/docs/doc/gocd-cli_version.md index cb77f9b..52afe6a 100644 --- a/docs/doc/gocd-cli_version.md +++ b/docs/doc/gocd-cli_version.md @@ -40,4 +40,4 @@ gocd-cli version [flags] * [gocd-cli](gocd-cli.md) - Command line interface for GoCD -###### Auto generated by spf13/cobra on 20-Mar-2023 +###### Auto generated by spf13/cobra on 21-Mar-2023 diff --git a/go.mod b/go.mod index 3b9f357..eec3a7c 100644 --- a/go.mod +++ b/go.mod @@ -4,7 +4,7 @@ go 1.19 require ( github.com/ghodss/yaml v1.0.0 - github.com/nikhilsbhat/gocd-sdk-go v0.1.1-0.20230313044033-c9dfdc7560a0 + github.com/nikhilsbhat/gocd-sdk-go v0.1.1 github.com/sirupsen/logrus v1.9.0 github.com/spf13/cobra v1.6.1 github.com/stretchr/testify v1.8.0 diff --git a/go.sum b/go.sum index 3b12bc5..6eb0c61 100644 --- a/go.sum +++ b/go.sum @@ -17,8 +17,8 @@ github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= -github.com/nikhilsbhat/gocd-sdk-go v0.1.1-0.20230313044033-c9dfdc7560a0 h1:QR1QyJwTpNbYZxUHDkuP4SUFPWNxJF1/xnVYLAegLJA= -github.com/nikhilsbhat/gocd-sdk-go v0.1.1-0.20230313044033-c9dfdc7560a0/go.mod h1:3XwSMe/nFH/I0Kt2+ToKKWFyD6yvJb4HaoP0dBHytY4= +github.com/nikhilsbhat/gocd-sdk-go v0.1.1 h1:y+nST//gKW0DvsKPzrLBaiOm2Qz9D4O/cIUUvZTPdM4= +github.com/nikhilsbhat/gocd-sdk-go v0.1.1/go.mod h1:3XwSMe/nFH/I0Kt2+ToKKWFyD6yvJb4HaoP0dBHytY4= github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=