From 2607866c49a2a3cca97a2ae2d565e82ae44c1c85 Mon Sep 17 00:00:00 2001 From: Andrey Nering Date: Sat, 15 Jul 2017 15:37:24 -0300 Subject: [PATCH] readme: document new syntax for synamic variables --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ef1e2fe3..b5f8e31d 100644 --- a/README.md +++ b/README.md @@ -303,7 +303,7 @@ Example of `Taskvars.yml` file: ```yml PROJECT_NAME: My Project DEV_MODE: production -GIT_COMMIT: $git log -n 1 --format=%h +GIT_COMMIT: {sh: git log -n 1 --format=%h} ``` > NOTE: It's also possible setting a variable globally using `set` attribute @@ -323,20 +323,34 @@ set-message: #### Dynamic variables -If you prefix a variable with `$`, then the variable is considered a dynamic -variable. The value after the $-symbol will be treated as a command and the -output assigned. +The below syntax (`sh:` prop in a variable) is considered a dynamic +variable. The value will be treated as a command and the output assigned. ```yml build: cmds: - - go build -ldflags="-X main.Version={{.LAST_GIT_COMMIT}}" main.go + - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go vars: - LAST_GIT_COMMIT: $git log -n 1 --format=%h + GIT_COMMIT: + sh: git log -n 1 --format=%h ``` This works for all types of variables. +> It's also possible to prefix the variable with `$` to have a dynamic +variable, but this is now considered deprecated: + +```yml +# Taskvars.yml + +# recommended +GIT_COMMIT: + sh: git log -n 1 --format=%h + +# deprecated +GIT_COMMIT: $git log -n 1 --format=%h +``` + ### Go's template engine Task parse commands as [Go's template engine][gotemplate] before executing