aboutsummaryrefslogtreecommitdiffhomepage
path: root/infra/bots/recipes/README.md
diff options
context:
space:
mode:
authorGravatar Eric Boren <borenet@google.com>2017-04-12 10:17:36 -0400
committerGravatar Skia Commit-Bot <skia-commit-bot@chromium.org>2017-04-12 16:41:01 +0000
commit8e02684311a25df0c07e4d104022edf4200838b8 (patch)
treea2dafa4f41d353f90c373ee0159a54212b508f22 /infra/bots/recipes/README.md
parent547a7272fab6937af8e9daed011c78127726f64f (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/recipes/README.md')
-rw-r--r--infra/bots/recipes/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/infra/bots/recipes/README.md b/infra/bots/recipes/README.md
new file mode 100644
index 0000000000..a9c4c6ab43
--- /dev/null
+++ b/infra/bots/recipes/README.md
@@ -0,0 +1,21 @@
+Skia Recipes
+============
+
+These are the top-level scripts which run inside of Swarming tasks to perform
+all of Skia's automated testing.
+
+To run a recipe locally:
+
+ $ python infra/bots/recipes.py run --workdir=/tmp/<workdir> <recipe name without .py> key1=value1 key2=value2 ...
+
+Each recipe may have its own required properties which must be entered as
+key/value pairs in the command.
+
+When you change a recipe, you generally need to re-train the simulation test:
+
+ $ python infra/bots/recipes.py simulation_test train
+
+The simulation_test generates expectations files for the tests contained within
+each recipe which illustrate which steps would run, given a particular set of
+inputs. Pay attention to the diffs in these files when making changes to ensure
+that your change has the intended effect.