Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Tutorial Examples

Progressive tutorials that teach one recipe runner feature at a time. Each tutorial is a self-contained YAML recipe you can run directly.

Source: examples/tutorials/

Tutorials

#RecipeFeatureRun it
01hello-worldSimplest recipe — one bash steprecipe-runner-rs examples/tutorials/01-hello-world.yaml
02variablesTemplate {{variables}} and contextrecipe-runner-rs examples/tutorials/02-variables.yaml
03conditionsConditional step executionrecipe-runner-rs examples/tutorials/03-conditions.yaml
04multi-step-pipelineSequential steps with output chainingrecipe-runner-rs examples/tutorials/04-multi-step-pipeline.yaml
05working-directoriesPer-step working_dirrecipe-runner-rs examples/tutorials/05-working-directories.yaml
06parse-jsonJSON extraction from outputrecipe-runner-rs examples/tutorials/06-parse-json.yaml
07error-handlingcontinue_on_errorrecipe-runner-rs examples/tutorials/07-error-handling.yaml
08hooksPre/post/on_error hooksrecipe-runner-rs examples/tutorials/08-hooks.yaml
09tagswhen_tags + --include-tagsrecipe-runner-rs examples/tutorials/09-tags.yaml --include-tags fast
10parallel-groupsparallel_group concurrent executionrecipe-runner-rs examples/tutorials/10-parallel-groups.yaml
11extendsRecipe inheritance via extendsrecipe-runner-rs examples/tutorials/11-extends.yaml
12recursion-limitsrecursion configrecipe-runner-rs examples/tutorials/12-recursion-limits.yaml
13timeoutsStep-level timeoutrecipe-runner-rs examples/tutorials/13-timeouts.yaml
14dry-run--dry-run moderecipe-runner-rs examples/tutorials/14-dry-run.yaml --dry-run

Start with 01-hello-world and work through sequentially. Each tutorial builds on concepts from previous ones.