xref: /third_party/skia/infra/bots/recipes/README.md (revision cb93a386)
1cb93a386Sopenharmony_ciSkia Recipes
2cb93a386Sopenharmony_ci============
3cb93a386Sopenharmony_ci
4cb93a386Sopenharmony_ciThese are the top-level scripts which run inside of Swarming tasks to perform
5cb93a386Sopenharmony_ciall of Skia's automated testing.
6cb93a386Sopenharmony_ci
7cb93a386Sopenharmony_ciTo run a recipe locally:
8cb93a386Sopenharmony_ci
9cb93a386Sopenharmony_ci	$ python infra/bots/recipes.py run --workdir=/tmp/<workdir> <recipe name without .py> key1=value1 key2=value2 ...
10cb93a386Sopenharmony_ci
11cb93a386Sopenharmony_ciEach recipe may have its own required properties which must be entered as
12cb93a386Sopenharmony_cikey/value pairs in the command.
13cb93a386Sopenharmony_ci
14cb93a386Sopenharmony_ciWhen you change a recipe, you generally need to re-train the simulation test:
15cb93a386Sopenharmony_ci
16cb93a386Sopenharmony_ci	$ python infra/bots/recipes.py test train
17cb93a386Sopenharmony_ci
18cb93a386Sopenharmony_ciOr:
19cb93a386Sopenharmony_ci
20cb93a386Sopenharmony_ci        $ cd infra/bots; make train
21cb93a386Sopenharmony_ci
22cb93a386Sopenharmony_ciThe test generates expectations files for the tests contained within each
23cb93a386Sopenharmony_cirecipe which illustrate which steps would run, given a particular set of inputs.
24cb93a386Sopenharmony_ciPay attention to the diffs in these files when making changes to ensure that
25cb93a386Sopenharmony_ciyour change has the intended effect.
26