Merge pull request #75 from suzuki-shunsuke/docs/add-examples

docs: add examples

.cmdx.yaml

@@ -47,3 +47,8 @@ tasks:
   description: buildflow run for test
   usage: buildflow run for test
   script: "go run ./cmd/buildflow run"
+- name: test-example
+  short: te
+  description: test examples
+  usage: test examples
+  script: "bash scripts/test-example.sh"

.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
         bash ci/test.sh buildflow
     - name: test examples
       run: |
-        bash ci/test-example.sh
+        bash scripts/test-example.sh
 
     - name: remove changes
       # Sometimes it is failed to release by goreleaser due to changes of go.sum

.gitignore

@@ -4,3 +4,4 @@ bin/*
 .git-rm-branch.yml
 .buildflow.yaml
 .envrc
+examples/foo.txt

README.md

@@ -538,6 +538,16 @@ phases:
 
 Please see [examples](https://github.com/suzuki-shunsuke/buildflow/tree/master/examples).
 
+On the directory, there are some examples of configuration files.
+
+We can execute the build with them.
+
+For example,
+
+```
+$ buildflow run -c examples/hello_world.yaml
+```
+
 ### Configuration variables
 
 - PR: [Response body of GitHub API: Get a pull request](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#get-a-pull-request)

examples/import_phases.yaml

@@ -0,0 +1,8 @@
+---
+phases:
+- name: main
+  tasks:
+  - name: hello
+    command:
+      command: echo hello
+- import: phases.yaml

examples/import_tasks.yaml

@@ -0,0 +1,8 @@
+---
+phases:
+- name: main
+  tasks:
+  - name: hello
+    command:
+      command: echo hello
+  - import: tasks.yaml

examples/main_test.go

@@ -6,7 +6,7 @@ import (
 	"gotest.tools/v3/icmd"
 )
 
-func TestBuildflow(t *testing.T) {
+func TestBuildflow(t *testing.T) { //nolint:funlen
 	data := []struct {
 		title string
 		file  string
@@ -32,10 +32,22 @@ func TestBuildflow(t *testing.T) {
 			title: "read_file",
 			file:  "read_file.yaml",
 		},
+		{
+			title: "write_file",
+			file:  "write_file.yaml",
+		},
 		{
 			title: "command's standard input",
 			file:  "stdin.yaml",
 		},
+		{
+			title: "import phases from a file",
+			file:  "import_phases.yaml",
+		},
+		{
+			title: "import tasks from a file",
+			file:  "import_tasks.yaml",
+		},
 		{
 			title: "buildflow run fails as expected",
 			file:  "fail.yaml",

examples/phases.yaml

@@ -0,0 +1,12 @@
+---
+# This file is imported from import_phases.yaml
+- name: main 2
+  tasks:
+  - name: hello
+    command:
+      command: echo "main 2"
+- name: main
+  tasks:
+  - name: main 3
+    command:
+      command: echo "main 3"

examples/tasks.yaml

@@ -0,0 +1,8 @@
+---
+# This file is imported from import_tasks.yaml
+- name: foo
+  command:
+    command: echo foo
+- name: bar
+  command:
+    command: echo bar

examples/write_file.yaml

@@ -0,0 +1,10 @@
+---
+phases:
+- name: main
+  tasks:
+  - name: foo
+    write_file:
+      path: foo.txt
+      template: |
+        # This file is generated by write_file.yaml
+        hello {{.Task.Name}}

scripts/test-example.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -eu
+
+cd "$(dirname "$0")/.."
+
+tempdir=$(mktemp -d)
+go build -o "$tempdir/buildflow" ./cmd/buildflow
+export PATH="$tempdir:$PATH"
+cd examples
+# command -v buildflow
+go test -race -covermode=atomic ./...
+rm -R "$tempdir"