From 202326875f866cfe3df7e9a0769638e1c8f64e8e Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Mon, 17 Nov 2014 13:22:40 -0500 Subject: [PATCH] Update docs for local-exec push --- website/docs/source/v2/push/local-exec.html.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/website/docs/source/v2/push/local-exec.html.md b/website/docs/source/v2/push/local-exec.html.md index 4e3727f85..536a5eab9 100644 --- a/website/docs/source/v2/push/local-exec.html.md +++ b/website/docs/source/v2/push/local-exec.html.md @@ -23,8 +23,13 @@ shell command or script as part of a push. The Vagrant Push Local Exec strategy supports the following configuration options: -- `command` - The command to execute (as a string). +- `script` - The path to a script on disk (relative to the `Vagrantfile`) to + execute. Vagrant will attempt to convert this script to an executable, but an + exception will be raised if that fails. +- `inline` - The inline script to execute (as a string). +Please note - only one of the `script` and `inline` options may be specified in +a single push definition. ### Usage @@ -33,7 +38,7 @@ The Vagrant Push Local Exec strategy is defined in the `Vagrantfile` using the ```ruby config.push.define "local-exec" do |push| - push.command = <<-SCRIPT + push.inline = <<-SCRIPT scp . /var/www/website SCRIPT end @@ -44,7 +49,7 @@ them from the `Vagrantfile` like so: ```ruby config.push.define "local-exec" do |push| - push.command = File.read("my-script.sh") + push.script = "my-script.sh" end ```