From 5291f8d0d99e8e0073aff10f52e698676fe0bcff Mon Sep 17 00:00:00 2001 From: Ben Jackson Date: Wed, 20 Nov 2019 14:49:21 +1100 Subject: [PATCH] fix deploy help text, update docs --- cmd/deploy.go | 2 +- docs/commands/lagoon.md | 2 +- docs/commands/lagoon_deploy.md | 9 +++---- docs/commands/lagoon_deploy_branch.md | 39 +++++++++++++++++++++++++++ 4 files changed, 44 insertions(+), 8 deletions(-) create mode 100644 docs/commands/lagoon_deploy_branch.md diff --git a/cmd/deploy.go b/cmd/deploy.go index 397f54be..86486c57 100644 --- a/cmd/deploy.go +++ b/cmd/deploy.go @@ -33,7 +33,7 @@ func parseDeployFlags(flags pflag.FlagSet) DeployFlags { var deployCmd = &cobra.Command{ Use: "deploy", Aliases: []string{"d"}, - Short: "Add a project, or add notifications and variables to projects or environments", + Short: "deploy a branch or environment", PersistentPreRun: func(cmd *cobra.Command, args []string) { validateToken(viper.GetString("current")) // get a new token if the current one is invalid }, diff --git a/docs/commands/lagoon.md b/docs/commands/lagoon.md index 6b65d9de..49df8538 100644 --- a/docs/commands/lagoon.md +++ b/docs/commands/lagoon.md @@ -32,7 +32,7 @@ lagoon [flags] * [lagoon add](lagoon_add.md) - Add a project, or add notifications and variables to projects or environments * [lagoon config](lagoon_config.md) - Configure Lagoon CLI * [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments -* [lagoon deploy](lagoon_deploy.md) - Deploy a latest branch +* [lagoon deploy](lagoon_deploy.md) - deploy a branch or environment * [lagoon get](lagoon_get.md) - Get info on a project, or deployment * [lagoon list](lagoon_list.md) - List projects, deployments, variables or notifications * [lagoon login](lagoon_login.md) - Log into a Lagoon instance diff --git a/docs/commands/lagoon_deploy.md b/docs/commands/lagoon_deploy.md index a0c64c0a..99c72029 100644 --- a/docs/commands/lagoon_deploy.md +++ b/docs/commands/lagoon_deploy.md @@ -1,14 +1,10 @@ ## lagoon deploy -Deploy a latest branch +deploy a branch or environment ### Synopsis -Deploy a latest branch - -``` -lagoon deploy [project name] [branch name] [flags] -``` +deploy a branch or environment ### Options @@ -35,4 +31,5 @@ lagoon deploy [project name] [branch name] [flags] ### SEE ALSO * [lagoon](lagoon.md) - Command line integration for Lagoon +* [lagoon deploy branch](lagoon_deploy_branch.md) - Deploy a latest branch diff --git a/docs/commands/lagoon_deploy_branch.md b/docs/commands/lagoon_deploy_branch.md new file mode 100644 index 00000000..512e5c95 --- /dev/null +++ b/docs/commands/lagoon_deploy_branch.md @@ -0,0 +1,39 @@ +## lagoon deploy branch + +Deploy a latest branch + +### Synopsis + +Deploy a latest branch + +``` +lagoon deploy branch [flags] +``` + +### Options + +``` + -b, --branch string branch name + -h, --help help for branch +``` + +### Options inherited from parent commands + +``` + --all-projects All projects (if supported) + -e, --environment string Specify an environment to use + --force Force (if supported) + -l, --lagoon string The Lagoon instance to interact with + --no-header No header on table (if supported) + --output-csv Output as CSV (if supported) + --output-json Output as JSON (if supported) + --pretty Make JSON pretty (if supported) + -p, --project string Specify a project to use + -i, --ssh-key string Specify a specific SSH key to use + --version Version information +``` + +### SEE ALSO + +* [lagoon deploy](lagoon_deploy.md) - deploy a branch or environment +