commit | b6f83ba9c0a56a988dde16e04a6c0462e3210650 | [log] [tgz] |
---|---|---|
author | Quinten Yearsley <qyearsley@chromium.org> | Mon Dec 28 23:39:15 2020 |
committer | LUCI CQ <infra-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Dec 28 23:39:15 2020 |
tree | 017b1f2cd0c21e0c68a92b6f24d719c69cfe6580 | |
parent | 32f0255a6910af47c6cb35546032ae4d60fe9a92 [diff] |
recipes docs: Rename old_user_guide to walkthrough and add links The new user guide says it's a rewrite of the old one, but they're written quite differently; the old one is a sequential walkthrough about recipes themselves, whereas the new user guide has much more information about the recipe engine ecosystem. So instead of merging them, I thought it would be nice to keep the old one (mostly intact) as a walkthrough. This CL: * Removes some old things from old_user_guide (mentions of buildbot) * Renames the file * Adds links Recipe-Manual-Change: build Bug: 1147490 Change-Id: I1295053b11c13e8f48d46489b9aff0f3d751c61e Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/recipes-py/+/2601174 Commit-Queue: Quinten Yearsley <qyearsley@chromium.org> Reviewed-by: Robbie Iannucci <iannucci@chromium.org> Reviewed-by: Yiwei Zhang <yiwzhang@google.com>
Recipes are a domain-specific language (embedded in Python) for specifying sequences of subprocess calls in a cross-platform and testable way.
They allow writing build flows which integrate with the rest of LUCI.
Documentation for the recipe engine (including this file!). Take a look at the user guide for some hints on how to get started. See the implementation details doc for more detailed implementation information about the recipe engine.
user.email
and user.name
are configured in git config
.Run the following to setup the code review tool and create your first review:
# Get `depot_tools` in $PATH if you don't have it git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $HOME/src/depot_tools export PATH="$PATH:$HOME/src/depot_tools" # Check out the recipe engine repo git clone https://chromium.googlesource.com/infra/luci/recipes-py $HOME/src/recipes-py # make your change cd $HOME/src/recipes-py git new-branch cool_feature # hack hack git commit -a -m "This is awesome" # This will ask for your Google Account credentials. git cl upload -s -r joe@example.com # 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.
Use git cl help
and git cl help <cmd>
for more details.