This is a quick-start guide for Chrome OS Recipes. For more in-depth information about the Recipes framework, see the Recipes User Guide.
The recipes and recipe modules in this repo have documentation auto-generated by the ‘test train’ process: README.recipes.md
The recipes.py script in this repo will bootstrap itself. You can verify that it is working by running tests:
./recipes.py test run
After making a change, you will usually need to “re-train” expected output in order for tests to pass:
./recipes.py test train
This will also regenerate the README.recipes.md documentation. That file and the expectation data in
*.expected directories should be checked in with your changes.
This repo contains some non-recipes support tooling in the support/ directory. These tools are delivered to CI hosts via CIPD. This process is automated by the
support/deploy_cipd.sh script. See support/README.txt for more details.
The Python code in this repo should largely conform to Chromium Python style except that Recipes code has a convention of 2 space indents. Practically, we use YAPF for automatic code formatting; whatever style is generated by YAPF should be used.
The code in this repo uses docstring-based type annotations as implemented by the Sphinx Napoleon Plugin. This format is supported by PyCharm / IntelliJ (Settings > Tools > Python Integrated Tools > Docstring format > Google).
The Recipes framework does not require the RecipesApi subclass in recipe modules to have any particular name, but this repo has some tooling that expects it to be named
NameApi derived from the