Add parallel_fork docs

cookpad · Apr 5, 2017 · d21132c · d21132c
1 parent 2484132
commit d21132c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/docs/tasks.md b/docs/tasks.md
@@ -59,6 +59,23 @@ fork:
   execute: say -v "Victoria"" "I'm Victoria"
 ```
 
+## parallel_fork
+
+`parallel_fork` task applies its child branches the specified number of times in parallel,
+and adds the enviroment value `KUROKO2_PARALLEL_FORK_INDEX` and `KUROKO2_PARALLEL_FORK_SIZE` automatically.
+
+**Option**
+
+A number of parallel size.
+
+**Example**
+
+```
+parallel_fork: 5
+  execute: sleep $KUROKO2_PARALLEL_INDEX
+  execute: echo $KUROKO2_PARALLEL_FORK_INDEX $KUROKO2_PARALLEL_FORK_SIZE
+```
+
 ## noop
 
 `noop` does nothing. This is a task for test purpose.

diff --git a/lib/autoload/kuroko2/workflow/task/parallel_fork.rb b/lib/autoload/kuroko2/workflow/task/parallel_fork.rb
@@ -2,7 +2,7 @@ module Kuroko2
   module Workflow
     module Task
       class ParallelFork < Fork
-        def vallidate
+        def validate
           super
           raise Workflow::AssertionError, "ParallelFork must have a parallel size (Int)" unless option.present? && option.match(/\A\d+\z/)
         end