diff options
| author |  Eric Boren <borenet@google.com> | 2017-04-12 10:17:36 -0400 |
|---|---|---|
| committer |  Skia Commit-Bot <skia-commit-bot@chromium.org> | 2017-04-12 16:41:01 +0000 |
| commit | 8e02684311a25df0c07e4d104022edf4200838b8 (patch) | |
| tree | a2dafa4f41d353f90c373ee0159a54212b508f22 /infra/bots/recipe_modules | |
| parent | 547a7272fab6937af8e9daed011c78127726f64f (diff) | |
Add/edit README files for infra/recipes
Bug: skia:6473
Change-Id: I050df47a5a3f633263f0ca6258e83e96b78d7957
Reviewed-on: https://skia-review.googlesource.com/13123
Commit-Queue: Eric Boren <borenet@google.com>
Reviewed-by: Stephan Altmueller <stephana@google.com>
Reviewed-by: Mike Klein <mtklein@chromium.org>
Reviewed-by: Kevin Lubick <kjlubick@google.com>
Reviewed-by: Ben Wagner <benjaminwagner@google.com>
Diffstat (limited to 'infra/bots/recipe_modules')
| -rw-r--r-- | infra/bots/recipe_modules/README.md | 32 |
1 files changed, 26 insertions, 6 deletions
diff --git a/infra/bots/recipe_modules/README.md b/infra/bots/recipe_modules/README.md index 05ad2cc76b..3ddf5ab248 100644 --- a/infra/bots/recipe_modules/README.md +++ b/infra/bots/recipe_modules/README.md @@ -1,11 +1,31 @@ Skia Recipe Modules =================== -This directory contains recipe modules designed to be used by recipes. They -are all Skia-specific and some are interrelated: +This directory contains recipe modules designed to be used by recipes (see +infra/bots/recipes). They are all Skia-specific and some are interrelated: - * vars - Common variables used by Skia recipes. - * run - Utilities for running commands. Depends on vars. - * flavor - Run meta-commands for various platforms. Depends on vars and run. - * skia - Main module for Skia recipes. Depends on vars, run, and flavor. + * builder_name_schema - Helps to derive expected behavior from task (formerly + builder) names. + * core - Use as a starting point for most recipes: runs setup and sync steps. + * ct - Shared Cluster Telemetry utilities. + * flavor - Allows the caller to specify a high-level command to run, leaving + the platform-specific details to be handled by the specific flavor + module. + * infra - Shared infrastructure-related utilities. + * run - Utilities for running commands. * swarming - Utilities for running Swarming tasks. + * vars - Common global variables used by Skia recipes/modules. + +When you change a recipe module, you generally need to re-train the simulation +test: + + $ python infra/bots/recipes.py simulation_test train + +Each recipe module contains a few files: + + * api.py - This is the meat of the module. + * \_\_init\_\_.py - Contains a single DEPS variable, indicating the other + recipe modules on which this module depends. + * example.py - Optional, this file contains examples which demonstrate how to + use the module and should contain enough tests to achieve 100% coverage + for the module. The tests are run using the simulation_test command above. |