Skip to content

Commit

Permalink
fix deploy help text, update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shreddedbacon committed Nov 20, 2019
1 parent 18b88af commit 5291f8d
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 8 deletions.
2 changes: 1 addition & 1 deletion cmd/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/lagoon.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 3 additions & 6 deletions docs/commands/lagoon_deploy.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

39 changes: 39 additions & 0 deletions docs/commands/lagoon_deploy_branch.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 5291f8d

Please sign in to comment.