|author||Garrett Beaty <firstname.lastname@example.org>||Thu Apr 25 18:14:24 2019|
|committer||Commit Bot <email@example.com>||Thu Apr 25 18:14:24 2019|
Add an object for representing a step. The Step class has fields for all of the potential keys that would be in a step dict except for ~followup_annotations. Instead of having a field for ~followup_annotations, Step has a field for all of the pieces of information that were contained in ~followup_annotations. To temporarily maintain backwards-compatibility, Step implements the collections.Mapping interface. Modifications to a Step field is reflected in the value of corresponding key, whether the key field corresponds to its own key in the dictionary or an annotation in ~followup_annotations. Change-Id: Iccf636ff5f458e145bc13ba843d66e06c61accc2 Bug: 939120 Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/recipes-py/+/1542435 Commit-Queue: Garrett Beaty <firstname.lastname@example.org> Reviewed-by: Robbie Iannucci <email@example.com>
Recipes are a domain-specific language (embedded in python) for specifying sequences of subprocess calls in a cross-platform and testable way.
Documentation for the recipe engine (including this file!). See the design doc for more detailed design information about the recipe engine.
Chrome infra config files.
The main entry point to the recipe engine. It has many subcommands and flags; run
recipes.py -h to see them. Include this in your repository to start using recipes.
Recipes in the recipe engine. These are either example recipes, or recipes which are used to test the engine (see run_test.py to see these run)
Built in recipe modules. These are very useful when writing recipes; take a look in there, and look at each of their
examples subfolders to get an idea how to use them in a recipe.
The core functionality of the recipe engine. Noteworthy files include:
main.py-- The main entrypoint for the recipe engine.
recipes_cfg.proto-- The protobuf file which defines the format of a
third_party/-- third_party code which is vendored into the recipe engine.
recipe_api.py-- The api exposed to a recipe module.
unittests-- Unittests for the engine.
There are also several files which correspond to a subcommand of recipes.py;
autoroll are some examples.
Somewhat poorly named, these are higher level integration tests.
user.nameare configured in
Run the following to setup the code review tool and create your first review:
git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $HOME/src/depot_tools export PATH="$PATH:$HOME/src/depot_tools" git checkout -b work origin/master # hack hack git commit -a -m "This is awesome" # This will ask for your Google Account credentials. git cl upload -s -r firstname.lastname@example.org # Wait for approval over email. # Click "Submit to CQ" button or ask reviewer to do it for you. # Wait for the change to be tested and landed automatically.
git cl help and
git cl help <cmd> for more details.