chore: some minor fixes

dokku · Apr 19, 2020 · 21567ac · 21567ac
1 parent 549feb0
commit 21567ac
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 15 deletions.
diff --git a/docs/deployment/builds-management.md b/docs/deployment/builds-management.md
@@ -3,9 +3,9 @@
 > New as of 0.19.0
 
 ```
-builds:kill <app>  # Kill a running build for an app
+builds:cancel <app> # Cancel a running build for an app
 builds:list <app> # List all running builds
-builds:logs <app>  # Shows logs for a build
+builds:output <app> # Shows build output
 builds:report [<app>] [<flag>] # Displays a build report for one or more apps
 ```
 
@@ -15,14 +15,14 @@ builds:report [<app>] [<flag>] # Displays a build report for one
 
 ### Viewing the status of a deploy
 
-### Viewing logs for a running deploy
+### Viewing build output for a deploy
 
-### Killing a running deploy
+### Canceling a running deploy
 
-It can be useful to kill a deploy if that deploy does not appear to be progressing, is impacting other apps through system resource utilization, or if a successful deploy will result in app errors. To do so, the `builds:kill` command can be used:
+It can be useful to kill a deploy if that deploy does not appear to be progressing, is impacting other apps through system resource utilization, or if a successful deploy will result in app errors. To do so, the `builds:cancel` command can be used:
 
 ```shell
-dokku builds:kill node-js-app
+dokku builds:cancel node-js-app
 ```
 
 This command will send a `QUIT` signal to the Process Group ID of the process handling the deploy, and should terminate all processes within that process tree. Finally, it will unlock the deploy so that a new deploy may be immediately invoked.

diff --git a/plugins/builds/internal-functions b/plugins/builds/internal-functions
@@ -6,9 +6,9 @@ fn-builds-help-content() {
  declare desc="return logs plugin help content"
  cat <<help_content
  builds, Manage running builds
- builds:kill <app>, Kill a running build for an app
+ builds:cancel <app>, Cancel a running build for an app
  builds:list <app>, List all running builds
- builds:logs <app>, Shows logs for a build
+ builds:output <app>, Shows build output
  builds:report [<app>] [<flag>], Displays a build report for one or more apps
 help_content
 }

diff --git a/plugins/builds/subcommands/kill → plugins/builds/subcommands/cancel b/plugins/builds/subcommands/kill → plugins/builds/subcommands/cancel
@@ -3,9 +3,9 @@ set -eo pipefail
 [[ $DOKKU_TRACE ]] && set -x
 source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 
-cmd-builds-kill() {
- declare desc="kill a running build for an app"
- declare cmd="builds:kill"
+cmd-builds-cancel() {
+ declare desc="cancel a running build for an app"
+ declare cmd="builds:cancel"
  [[ "$1" == "$cmd" ]] && shift 1
  declare APP="$1"
  verify_app_name "$APP"

diff --git a/plugins/builds/subcommands/logs → plugins/builds/subcommands/output b/plugins/builds/subcommands/logs → plugins/builds/subcommands/output
@@ -3,9 +3,9 @@ set -eo pipefail
 [[ $DOKKU_TRACE ]] && set -x
 source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 
-cmd-builds-logs() {
- declare desc="shows logs for a build"
- declare cmd="builds:logs"
+cmd-builds-output() {
+ declare desc="shows build output"
+ declare cmd="builds:output"
  [[ "$1" == "$cmd" ]] && shift 1
  declare APP="$1"
  verify_app_name "$APP"
@@ -24,4 +24,4 @@ cmd-builds-logs() {
  fi
 }
 
-cmd-builds-logs "$@"
+cmd-builds-output "$@"