docs: add an example

suzuki-shunsuke · Oct 15, 2020 · 5bc3261 · 5bc3261
1 parent fa49244
commit 5bc3261
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/examples/command_file.sh b/examples/command_file.sh
@@ -0,0 +1,3 @@
+# This file is read from command_file.yaml
+# Go's text/teplate
+echo "{{.Task.Name}}"
diff --git a/examples/command_file.yaml b/examples/command_file.yaml
@@ -0,0 +1,7 @@
+---
+phases:
+- name: main
+  tasks:
+  - name: read command from a file
+    command:
+      command_file: command_file.sh
diff --git a/examples/main_test.go b/examples/main_test.go
@@ -16,6 +16,10 @@ func TestBuildflow(t *testing.T) { //nolint:funlen
 			title: "hello world",
 			file:  "hello_world.yaml",
 		},
+		{
+			title: "read command from a file (task.command_file)",
+			file:  "command_file.yaml",
+		},
 		{
 			title: "run tasks in parallel",
 			file:  "parallel.yaml",