Merge pull request #3247 from SirScott/vars_prompt_docs

Document the 'default' argument for vars_prompt.
This commit is contained in:
Michael DeHaan 2013-06-18 11:48:49 -07:00
commit 89ee762ab7

View file

@ -186,6 +186,15 @@ in a push-script::
There are full examples of both of these items in the github examples/playbooks directory. There are full examples of both of these items in the github examples/playbooks directory.
If you have a variable that changes infrequently, it might make sense to
provide a default value that can be overriden. This can be accomplished using
the default argument::
vars_prompt:
- name: "release_version"
prompt: "Product release version"
default: "1.0"
An alternative form of vars_prompt allows for hiding input from the user, and may later support An alternative form of vars_prompt allows for hiding input from the user, and may later support
some other options, but otherwise works equivalently:: some other options, but otherwise works equivalently::