diff --git a/docs/triggers.md b/docs/triggers.md index a84782c..2b3594c 100644 --- a/docs/triggers.md +++ b/docs/triggers.md @@ -4,6 +4,11 @@ ### Once +"Once" triggers run the node just one time during the flow. +This is the default trigger. + +Use this trigger when a command needs to run only one time during a flow. + ```yaml --8<-- "docs/examples/once.yaml" ``` @@ -12,6 +17,10 @@ ### After +"After" triggers run the node after some other nodes have completed. + +Use this trigger when a node depends on the output of another node. + ```yaml --8<-- "docs/examples/after.yaml" ``` @@ -20,6 +29,10 @@ ### Restart +"Restart" triggers run the node every time the node is completed. + +Use this trigger when you want to keep the node's command running. + ```yaml --8<-- "docs/examples/restart.yaml" ``` @@ -28,6 +41,11 @@ ### Watch +"Watch" triggers run the node every time one of the watched files changes +(directories are watched recursively). + +Use this trigger to run a node in reaction to changes in the filesystem. + ```yaml --8<-- "docs/examples/watch.yaml" ```